diff --git a/CHANGELOG.md b/CHANGELOG.md index 8561538e5..26c113b96 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,170 @@ +# 0.17.3 +* Backwards compatible changes: + * Added `oslogin_v1` + * Updated `androiddeviceprovisioning_v1` + * Updated `dlp_v2beta1` + * Updated `tpu_v1alpha1` + * Updated `vault_v1` + +# 0.17.2 +* Backwards compatible changes: + * Added `dialogflow_v2beta1` + * Added `serviceconsumermanagement_v1` + * Added `tpu_v1alpha1` + * Updated `admin_directory_v1` + * Updated `androidenterprise_v1` + * Updated `appengine_v1` + * Updated `appengine_v1beta` + * Updated `bigquerydatatransfer_v1` + * Updated `cloudbuild_v1` + * Updated `cloudiot_v1` + * Updated `cloudkms_v1` + * Updated `cloudtasks_v2beta2` + * Updated `compute_alpha` + * Updated `compute_beta` + * Updated `compute_v1` + * Updated `container_v1` + * Updated `container_v1beta1` + * Updated `customsearch_v1` + * Updated `dlp_v2beta1` + * Updated `genomics_v1alpha2` + * Updated `logging_v2` + * Updated `logging_v2beta1` + * Updated `monitoring_v3` + * Updated `proximitybeacon_v1beta1` + * Updated `script_v1` + * Updated `slides_v1` + * Updated `sourcerepo_v1` + * Updated `storagetransfer_v1` + * Updated `toolresults_v1beta3` + * Updated `youtube_partner_v1` + +# 0.17.1 +* Backwards compatible changes: + * Added `dfareporting_v3_0` + * Added `vision_v1p1beta1` + * Updated `adexchangebuyer2_v2beta1` + * Updated `analyticsreporting_v4` + * Updated `androidmanagement_v1` + * Updated `bigquerydatatransfer_v1` + * Updated `cloudtasks_v2beta2` + * Updated `cloudtrace_v1` + * Updated `cloudtrace_v2` + * Updated `container_v1` + * Updated `container_v1beta1` + * Updated `deploymentmanager_alpha` + * Updated `deploymentmanager_v2beta` + * Updated `dfareporting_v2_7` + * Updated `dfareporting_v2_8` + * Updated `firebasedynamiclinks_v1` + * Updated `firestore_v1beta1` + * Updated `ml_v1` + * Updated `monitoring_v3` + * Updated `oslogin_v1alpha` + * Updated `oslogin_v1beta` + * Updated `people_v1` + * Updated `script_v1` + * Updated `servicemanagement_v1` + * Updated `serviceuser_v1` + * Updated `spanner_v1` + * Updated `tagmanager_v1` + * Updated `tagmanager_v2` + * Updated `vision_v1` + * Updated `youtube_partner_v1` + +# 0.17.0 +* Breaking changes: + * Deleted `cloudmonitoring_v2beta2` +* Backwards compatible changes: + * Updated `adexchangebuyer2_v2beta1` + * Updated `bigquery_v2` + * Updated `cloudfunctions_v1` + * Updated `cloudfunctions_v1beta2` + * Updated `container_v1beta1` + * Updated `content_v2` + * Updated `content_v2sandbox` + * Updated `dataproc_v1` + * Updated `dataproc_v1beta2` + * Updated `videointelligence_v1beta1` + * Updated `vision_v1` + * Updated `youtube_partner_v1` + * Updated `youtube_v3` + +# 0.16.0 +* Breaking changes: + * Deleted `playmoviespartner_v1` + * Deleted `qpx_express_v1` +* Backwards compatible changes: + * Added `dns_v1beta2` + * Updated `adexchangebuyer2_v2beta1` + * Updated `admin_directory_v1` + * Updated `androidenterprise_v1` + * Updated `androidmanagement_v1` + * Updated `androidpublisher_v2` + * Updated `appengine_v1` + * Updated `appengine_v1alpha` + * Updated `appengine_v1beta` + * Updated `appengine_v1beta4` + * Updated `appengine_v1beta5` + * Updated `bigquery_v2` + * Updated `bigquerydatatransfer_v1` + * Updated `calendar_v3` + * Updated `classroom_v1` + * Updated `cloudbuild_v1` + * Updated `cloudfunctions_v1` + * Updated `cloudfunctions_v1beta2` + * Updated `cloudiot_v1` + * Updated `cloudiot_v1beta1` + * Updated `cloudtasks_v2beta2` + * Updated `cloudtrace_v2` + * Updated `compute_alpha` + * Updated `compute_beta` + * Updated `compute_v1` + * Updated `container_v1beta1` + * Updated `content_v2` + * Updated `content_v2sandbox` + * Updated `dataflow_v1b3` + * Updated `dataproc_v1beta2` + * Updated `datastore_v1` + * Updated `datastore_v1beta3` + * Updated `deploymentmanager_alpha` + * Updated `deploymentmanager_v2beta` + * Updated `dlp_v2beta1` + * Updated `drive_v2` + * Updated `drive_v3` + * Updated `firebasedynamiclinks_v1` + * Updated `firebaseremoteconfig_v1` + * Updated `firebaserules_v1` + * Updated `genomics_v1alpha2` + * Updated `iam_v1` + * Updated `language_v1` + * Updated `language_v1beta2` + * Updated `logging_v2` + * Updated `logging_v2beta1` + * Updated `manufacturers_v1` + * Updated `ml_v1` + * Updated `monitoring_v3` + * Updated `oslogin_v1alpha` + * Updated `oslogin_v1beta` + * Updated `partners_v2` + * Updated `proximitybeacon_v1beta1` + * Updated `runtimeconfig_v1beta1` + * Updated `script_v1` + * Updated `servicecontrol_v1` + * Updated `servicemanagement_v1` + * Updated `serviceuser_v1` + * Updated `sheets_v4` + * Updated `slides_v1` + * Updated `sourcerepo_v1` + * Updated `speech_v1` + * Updated `sqladmin_v1beta4` + * Updated `storage_v1` + * Updated `streetviewpublish_v1` + * Updated `testing_v1` + * Updated `toolresults_v1beta3` + * Updated `videointelligence_v1beta1` + * Updated `youtube_partner_v1` + # 0.15.0 * Breaking changes: * Deleted `ml_v1beta1` diff --git a/api_names_out.yaml b/api_names_out.yaml index aff6c04ac..f2f12dd3e 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -53,6 +53,7 @@ "/adexchangebuyer2:v2beta1/Client/entityId": entity_id "/adexchangebuyer2:v2beta1/Client/entityName": entity_name "/adexchangebuyer2:v2beta1/Client/entityType": entity_type +"/adexchangebuyer2:v2beta1/Client/partnerClientId": partner_client_id "/adexchangebuyer2:v2beta1/Client/role": role "/adexchangebuyer2:v2beta1/Client/status": status "/adexchangebuyer2:v2beta1/Client/visibleToSeller": visible_to_seller @@ -320,6 +321,7 @@ "/adexchangebuyer2:v2beta1/adexchangebuyer2.accounts.clients.list/accountId": account_id "/adexchangebuyer2:v2beta1/adexchangebuyer2.accounts.clients.list/pageSize": page_size "/adexchangebuyer2:v2beta1/adexchangebuyer2.accounts.clients.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.accounts.clients.list/partnerClientId": partner_client_id "/adexchangebuyer2:v2beta1/adexchangebuyer2.accounts.clients.update": update_account_client "/adexchangebuyer2:v2beta1/adexchangebuyer2.accounts.clients.update/accountId": account_id "/adexchangebuyer2:v2beta1/adexchangebuyer2.accounts.clients.update/clientAccountId": client_account_id @@ -433,6 +435,184 @@ "/adexchangebuyer2:v2beta1/adexchangebuyer2.accounts.filterSets.nonBillableWinningBids.list/filterSetId": filter_set_id "/adexchangebuyer2:v2beta1/adexchangebuyer2.accounts.filterSets.nonBillableWinningBids.list/pageSize": page_size "/adexchangebuyer2:v2beta1/adexchangebuyer2.accounts.filterSets.nonBillableWinningBids.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list": list_bidder_account_filter_set_bid_metrics +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list": list_bidder_account_filter_set_bid_response_errors +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list": list_bidder_account_filter_set_bid_responses_without_bids +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.create": create_bidder_account_filter_set +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.create/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.create/isTransient": is_transient +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.create/ownerName": owner_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.delete": delete_bidder_account_filter_set +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.delete/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.delete/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.delete/name": name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list": list_bidder_account_filter_set_filtered_bid_requests +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list": list_bidder_account_filter_set_filtered_bid_creatives +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list/creativeStatusId": creative_status_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list": list_bidder_account_filter_set_filtered_bid_details +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list/creativeStatusId": creative_status_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list": list_bidder_account_filter_set_filtered_bids +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.get": get_bidder_account_filter_set +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.get/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.get/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.get/name": name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list": list_bidder_account_filter_set_impression_metrics +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.list": list_bidder_account_filter_sets +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.list/ownerName": owner_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.losingBids.list": list_bidder_account_filter_set_losing_bids +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.losingBids.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.losingBids.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.losingBids.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.losingBids.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.losingBids.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list": list_bidder_account_filter_set_non_billable_winning_bids +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidMetrics.list": list_bidder_filter_set_bid_metrics +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidMetrics.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidMetrics.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidMetrics.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidMetrics.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidMetrics.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidResponseErrors.list": list_bidder_filter_set_bid_response_errors +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidResponseErrors.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidResponseErrors.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidResponseErrors.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidResponseErrors.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidResponseErrors.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list": list_bidder_filter_set_bid_responses_without_bids +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create": create_bidder_filter_set +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.absoluteDateRange.endDate.day": filter_set_absolute_date_range_end_date_day +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.absoluteDateRange.endDate.month": filter_set_absolute_date_range_end_date_month +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.absoluteDateRange.endDate.year": filter_set_absolute_date_range_end_date_year +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.absoluteDateRange.startDate.day": filter_set_absolute_date_range_start_date_day +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.absoluteDateRange.startDate.month": filter_set_absolute_date_range_start_date_month +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.absoluteDateRange.startDate.year": filter_set_absolute_date_range_start_date_year +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.buyerAccountId": filter_set_buyer_account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.creativeId": filter_set_creative_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.dealId": filter_set_deal_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.environment": filter_set_environment +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.filterSetId": filter_set_filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.format": filter_set_format +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.name": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.ownerAccountId": filter_set_owner_account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.platforms": filter_set_platforms +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.realtimeTimeRange.startTimestamp": filter_set_realtime_time_range_start_timestamp +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.relativeDateRange.durationDays": filter_set_relative_date_range_duration_days +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.relativeDateRange.offsetDays": filter_set_relative_date_range_offset_days +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.sellerNetworkIds": filter_set_seller_network_ids +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/filterSet.timeSeriesGranularity": filter_set_time_series_granularity +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/isTransient": is_transient +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.create/ownerName": owner_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.delete": delete_bidder_filter_set +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.delete/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.delete/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.delete/name": name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBidRequests.list": list_bidder_filter_set_filtered_bid_requests +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBidRequests.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBidRequests.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBidRequests.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBidRequests.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBidRequests.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list": list_bidder_filter_set_filtered_bid_creatives +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list/creativeStatusId": creative_status_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.details.list": list_bidder_filter_set_filtered_bid_details +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.details.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.details.list/creativeStatusId": creative_status_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.details.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.details.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.details.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.details.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.list": list_bidder_filter_set_filtered_bids +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.filteredBids.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.get": get_bidder_filter_set +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.get/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.get/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.get/name": name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.impressionMetrics.list": list_bidder_filter_set_impression_metrics +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.impressionMetrics.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.impressionMetrics.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.impressionMetrics.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.impressionMetrics.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.impressionMetrics.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.list": list_bidder_filter_sets +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.list/ownerName": owner_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.losingBids.list": list_bidder_filter_set_losing_bids +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.losingBids.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.losingBids.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.losingBids.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.losingBids.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.losingBids.list/pageToken": page_token +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list": list_bidder_filter_set_non_billable_winning_bids +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list/accountId": account_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list/filterSetId": filter_set_id +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list/filterSetName": filter_set_name +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list/pageSize": page_size +"/adexchangebuyer2:v2beta1/adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list/pageToken": page_token "/adexchangebuyer2:v2beta1/fields": fields "/adexchangebuyer2:v2beta1/key": key "/adexchangebuyer2:v2beta1/quotaUser": quota_user @@ -2022,6 +2202,16 @@ "/admin:directory_v1/Aliases/aliases/alias": alias "/admin:directory_v1/Aliases/etag": etag "/admin:directory_v1/Aliases/kind": kind +"/admin:directory_v1/AppAccessCollections": app_access_collections +"/admin:directory_v1/AppAccessCollections/blockedApiAccessBuckets": blocked_api_access_buckets +"/admin:directory_v1/AppAccessCollections/blockedApiAccessBuckets/blocked_api_access_bucket": blocked_api_access_bucket +"/admin:directory_v1/AppAccessCollections/enforceSettingsForAndroidDrive": enforce_settings_for_android_drive +"/admin:directory_v1/AppAccessCollections/errorMessage": error_message +"/admin:directory_v1/AppAccessCollections/etag": etag +"/admin:directory_v1/AppAccessCollections/kind": kind +"/admin:directory_v1/AppAccessCollections/resourceId": resource_id +"/admin:directory_v1/AppAccessCollections/resourceName": resource_name +"/admin:directory_v1/AppAccessCollections/trustDomainOwnedApps": trust_domain_owned_apps "/admin:directory_v1/Asp": asp "/admin:directory_v1/Asp/codeId": code_id "/admin:directory_v1/Asp/creationTime": creation_time @@ -2185,6 +2375,8 @@ "/admin:directory_v1/Members/members": members "/admin:directory_v1/Members/members/member": member "/admin:directory_v1/Members/nextPageToken": next_page_token +"/admin:directory_v1/MembersHasMember": members_has_member +"/admin:directory_v1/MembersHasMember/isMember": is_member "/admin:directory_v1/MobileDevice": mobile_device "/admin:directory_v1/MobileDevice/adbStatus": adb_status "/admin:directory_v1/MobileDevice/applications": applications @@ -2360,6 +2552,18 @@ "/admin:directory_v1/Tokens/items": items "/admin:directory_v1/Tokens/items/item": item "/admin:directory_v1/Tokens/kind": kind +"/admin:directory_v1/TrustedAppId": trusted_app_id +"/admin:directory_v1/TrustedAppId/androidPackageName": android_package_name +"/admin:directory_v1/TrustedAppId/certificateHashSHA1": certificate_hash_sha1 +"/admin:directory_v1/TrustedAppId/certificateHashSHA256": certificate_hash_sha256 +"/admin:directory_v1/TrustedAppId/etag": etag +"/admin:directory_v1/TrustedAppId/kind": kind +"/admin:directory_v1/TrustedApps": trusted_apps +"/admin:directory_v1/TrustedApps/etag": etag +"/admin:directory_v1/TrustedApps/kind": kind +"/admin:directory_v1/TrustedApps/nextPageToken": next_page_token +"/admin:directory_v1/TrustedApps/trustedApps": trusted_apps +"/admin:directory_v1/TrustedApps/trustedApps/trusted_app": trusted_app "/admin:directory_v1/User": user "/admin:directory_v1/User/addresses": addresses "/admin:directory_v1/User/agreedToTerms": agreed_to_terms @@ -2495,6 +2699,7 @@ "/admin:directory_v1/UserPhoto/primaryEmail": primary_email "/admin:directory_v1/UserPhoto/width": width "/admin:directory_v1/UserPosixAccount": user_posix_account +"/admin:directory_v1/UserPosixAccount/accountId": account_id "/admin:directory_v1/UserPosixAccount/gecos": gecos "/admin:directory_v1/UserPosixAccount/gid": gid "/admin:directory_v1/UserPosixAccount/homeDirectory": home_directory @@ -2626,6 +2831,9 @@ "/admin:directory_v1/directory.members.get": get_member "/admin:directory_v1/directory.members.get/groupKey": group_key "/admin:directory_v1/directory.members.get/memberKey": member_key +"/admin:directory_v1/directory.members.hasMember": has_member_member +"/admin:directory_v1/directory.members.hasMember/groupKey": group_key +"/admin:directory_v1/directory.members.hasMember/memberKey": member_key "/admin:directory_v1/directory.members.insert": insert_member "/admin:directory_v1/directory.members.insert/groupKey": group_key "/admin:directory_v1/directory.members.list": list_members @@ -2694,6 +2902,8 @@ "/admin:directory_v1/directory.orgunits.update/orgUnitPath": org_unit_path "/admin:directory_v1/directory.privileges.list": list_privileges "/admin:directory_v1/directory.privileges.list/customer": customer +"/admin:directory_v1/directory.resolvedAppAccessSettings.GetSettings": get_resolved_app_access_setting_settings +"/admin:directory_v1/directory.resolvedAppAccessSettings.ListTrustedApps": list_resolved_app_access_setting_trusted_apps "/admin:directory_v1/directory.resources.calendars.delete": delete_calendar_resource "/admin:directory_v1/directory.resources.calendars.delete/calendarResourceId": calendar_resource_id "/admin:directory_v1/directory.resources.calendars.delete/customer": customer @@ -4710,9 +4920,12 @@ "/analyticsreporting:v4/GetReportsRequest": get_reports_request "/analyticsreporting:v4/GetReportsRequest/reportRequests": report_requests "/analyticsreporting:v4/GetReportsRequest/reportRequests/report_request": report_request +"/analyticsreporting:v4/GetReportsRequest/useResourceQuotas": use_resource_quotas "/analyticsreporting:v4/GetReportsResponse": get_reports_response +"/analyticsreporting:v4/GetReportsResponse/queryCost": query_cost "/analyticsreporting:v4/GetReportsResponse/reports": reports "/analyticsreporting:v4/GetReportsResponse/reports/report": report +"/analyticsreporting:v4/GetReportsResponse/resourceQuotasRemaining": resource_quotas_remaining "/analyticsreporting:v4/Metric": metric "/analyticsreporting:v4/Metric/alias": alias "/analyticsreporting:v4/Metric/expression": expression @@ -4814,6 +5027,9 @@ "/analyticsreporting:v4/ReportRow/dimensions/dimension": dimension "/analyticsreporting:v4/ReportRow/metrics": metrics "/analyticsreporting:v4/ReportRow/metrics/metric": metric +"/analyticsreporting:v4/ResourceQuotasRemaining": resource_quotas_remaining +"/analyticsreporting:v4/ResourceQuotasRemaining/dailyQuotaTokensRemaining": daily_quota_tokens_remaining +"/analyticsreporting:v4/ResourceQuotasRemaining/hourlyQuotaTokensRemaining": hourly_quota_tokens_remaining "/analyticsreporting:v4/Segment": segment "/analyticsreporting:v4/Segment/dynamicSegment": dynamic_segment "/analyticsreporting:v4/Segment/segmentId": segment_id @@ -5055,6 +5271,11 @@ "/androidenterprise:v1/AuthenticationToken/token": token "/androidenterprise:v1/CollectionViewersListResponse": list_collection_viewers_response "/androidenterprise:v1/CollectionsListResponse": list_collections_response +"/androidenterprise:v1/ConfigurationVariables": configuration_variables +"/androidenterprise:v1/ConfigurationVariables/kind": kind +"/androidenterprise:v1/ConfigurationVariables/mcmId": mcm_id +"/androidenterprise:v1/ConfigurationVariables/variableSet": variable_set +"/androidenterprise:v1/ConfigurationVariables/variableSet/variable_set": variable_set "/androidenterprise:v1/Device": device "/androidenterprise:v1/Device/androidId": android_id "/androidenterprise:v1/Device/kind": kind @@ -5126,6 +5347,7 @@ "/androidenterprise:v1/LocalizedText/locale": locale "/androidenterprise:v1/LocalizedText/text": text "/androidenterprise:v1/ManagedConfiguration": managed_configuration +"/androidenterprise:v1/ManagedConfiguration/configurationVariables": configuration_variables "/androidenterprise:v1/ManagedConfiguration/kind": kind "/androidenterprise:v1/ManagedConfiguration/managedProperty": managed_property "/androidenterprise:v1/ManagedConfiguration/managedProperty/managed_property": managed_property @@ -5138,6 +5360,16 @@ "/androidenterprise:v1/ManagedConfigurationsForUserListResponse/kind": kind "/androidenterprise:v1/ManagedConfigurationsForUserListResponse/managedConfigurationForUser": managed_configuration_for_user "/androidenterprise:v1/ManagedConfigurationsForUserListResponse/managedConfigurationForUser/managed_configuration_for_user": managed_configuration_for_user +"/androidenterprise:v1/ManagedConfigurationsSettings": managed_configurations_settings +"/androidenterprise:v1/ManagedConfigurationsSettings/kind": kind +"/androidenterprise:v1/ManagedConfigurationsSettings/managedProperty": managed_property +"/androidenterprise:v1/ManagedConfigurationsSettings/managedProperty/managed_property": managed_property +"/androidenterprise:v1/ManagedConfigurationsSettings/mcmId": mcm_id +"/androidenterprise:v1/ManagedConfigurationsSettings/name": name +"/androidenterprise:v1/ManagedConfigurationsSettingsListResponse": managed_configurations_settings_list_response +"/androidenterprise:v1/ManagedConfigurationsSettingsListResponse/kind": kind +"/androidenterprise:v1/ManagedConfigurationsSettingsListResponse/managedConfigurationsSettings": managed_configurations_settings +"/androidenterprise:v1/ManagedConfigurationsSettingsListResponse/managedConfigurationsSettings/managed_configurations_setting": managed_configurations_setting "/androidenterprise:v1/ManagedProperty": managed_property "/androidenterprise:v1/ManagedProperty/key": key "/androidenterprise:v1/ManagedProperty/valueBool": value_bool @@ -5305,6 +5537,10 @@ "/androidenterprise:v1/UsersListResponse/kind": kind "/androidenterprise:v1/UsersListResponse/user": user "/androidenterprise:v1/UsersListResponse/user/user": user +"/androidenterprise:v1/VariableSet": variable_set +"/androidenterprise:v1/VariableSet/kind": kind +"/androidenterprise:v1/VariableSet/placeholder": placeholder +"/androidenterprise:v1/VariableSet/userValue": user_value "/androidenterprise:v1/androidenterprise.collectionviewers.delete": delete_collection_viewer "/androidenterprise:v1/androidenterprise.collectionviewers.get": get_collection_viewer "/androidenterprise:v1/androidenterprise.collectionviewers.list": list_collection_viewers @@ -5459,6 +5695,9 @@ "/androidenterprise:v1/androidenterprise.managedconfigurationsforuser.update/enterpriseId": enterprise_id "/androidenterprise:v1/androidenterprise.managedconfigurationsforuser.update/managedConfigurationForUserId": managed_configuration_for_user_id "/androidenterprise:v1/androidenterprise.managedconfigurationsforuser.update/userId": user_id +"/androidenterprise:v1/androidenterprise.managedconfigurationssettings.list": list_managedconfigurationssettings +"/androidenterprise:v1/androidenterprise.managedconfigurationssettings.list/enterpriseId": enterprise_id +"/androidenterprise:v1/androidenterprise.managedconfigurationssettings.list/productId": product_id "/androidenterprise:v1/androidenterprise.permissions.get": get_permission "/androidenterprise:v1/androidenterprise.permissions.get/language": language "/androidenterprise:v1/androidenterprise.permissions.get/permissionId": permission_id @@ -5559,6 +5798,9 @@ "/androidenterprise:v1/androidenterprise.users.patch": patch_user "/androidenterprise:v1/androidenterprise.users.patch/enterpriseId": enterprise_id "/androidenterprise:v1/androidenterprise.users.patch/userId": user_id +"/androidenterprise:v1/androidenterprise.users.revokeDeviceAccess": revoke_user_device_access +"/androidenterprise:v1/androidenterprise.users.revokeDeviceAccess/enterpriseId": enterprise_id +"/androidenterprise:v1/androidenterprise.users.revokeDeviceAccess/userId": user_id "/androidenterprise:v1/androidenterprise.users.revokeToken": revoke_user_token "/androidenterprise:v1/androidenterprise.users.revokeToken/enterpriseId": enterprise_id "/androidenterprise:v1/androidenterprise.users.revokeToken/userId": user_id @@ -6510,6 +6752,7 @@ "/appengine:v1/AutomaticScaling/minTotalInstances": min_total_instances "/appengine:v1/AutomaticScaling/networkUtilization": network_utilization "/appengine:v1/AutomaticScaling/requestUtilization": request_utilization +"/appengine:v1/AutomaticScaling/standardSchedulerSettings": standard_scheduler_settings "/appengine:v1/BasicScaling": basic_scaling "/appengine:v1/BasicScaling/idleTimeout": idle_timeout "/appengine:v1/BasicScaling/maxInstances": max_instances @@ -6748,6 +6991,11 @@ "/appengine:v1/Service/split": split "/appengine:v1/SslSettings": ssl_settings "/appengine:v1/SslSettings/certificateId": certificate_id +"/appengine:v1/StandardSchedulerSettings": standard_scheduler_settings +"/appengine:v1/StandardSchedulerSettings/maxInstances": max_instances +"/appengine:v1/StandardSchedulerSettings/minInstances": min_instances +"/appengine:v1/StandardSchedulerSettings/targetCpuUtilization": target_cpu_utilization +"/appengine:v1/StandardSchedulerSettings/targetThroughputUtilization": target_throughput_utilization "/appengine:v1/StaticFilesHandler": static_files_handler "/appengine:v1/StaticFilesHandler/applicationReadable": application_readable "/appengine:v1/StaticFilesHandler/expiration": expiration @@ -6851,6 +7099,7 @@ "/appengine:v1/appengine.apps.create": create_app "/appengine:v1/appengine.apps.domainMappings.create": create_app_domain_mapping "/appengine:v1/appengine.apps.domainMappings.create/appsId": apps_id +"/appengine:v1/appengine.apps.domainMappings.create/overrideStrategy": override_strategy "/appengine:v1/appengine.apps.domainMappings.delete": delete_app_domain_mapping "/appengine:v1/appengine.apps.domainMappings.delete/appsId": apps_id "/appengine:v1/appengine.apps.domainMappings.delete/domainMappingsId": domain_mappings_id @@ -7119,6 +7368,7 @@ "/appengine:v1alpha/appengine.apps.domainMappings.create": create_app_domain_mapping "/appengine:v1alpha/appengine.apps.domainMappings.create/appsId": apps_id "/appengine:v1alpha/appengine.apps.domainMappings.create/noManagedCertificate": no_managed_certificate +"/appengine:v1alpha/appengine.apps.domainMappings.create/overrideStrategy": override_strategy "/appengine:v1alpha/appengine.apps.domainMappings.delete": delete_app_domain_mapping "/appengine:v1alpha/appengine.apps.domainMappings.delete/appsId": apps_id "/appengine:v1alpha/appengine.apps.domainMappings.delete/domainMappingsId": domain_mappings_id @@ -7253,6 +7503,7 @@ "/appengine:v1beta/ErrorHandler/staticFile": static_file "/appengine:v1beta/FeatureSettings": feature_settings "/appengine:v1beta/FeatureSettings/splitHealthChecks": split_health_checks +"/appengine:v1beta/FeatureSettings/useContainerOptimizedOs": use_container_optimized_os "/appengine:v1beta/FileInfo": file_info "/appengine:v1beta/FileInfo/mimeType": mime_type "/appengine:v1beta/FileInfo/sha1Sum": sha1_sum @@ -7559,6 +7810,7 @@ "/appengine:v1beta/appengine.apps.create": create_app "/appengine:v1beta/appengine.apps.domainMappings.create": create_app_domain_mapping "/appengine:v1beta/appengine.apps.domainMappings.create/appsId": apps_id +"/appengine:v1beta/appengine.apps.domainMappings.create/overrideStrategy": override_strategy "/appengine:v1beta/appengine.apps.domainMappings.delete": delete_app_domain_mapping "/appengine:v1beta/appengine.apps.domainMappings.delete/appsId": apps_id "/appengine:v1beta/appengine.apps.domainMappings.delete/domainMappingsId": domain_mappings_id @@ -7731,6 +7983,9 @@ "/appengine:v1beta4/DiskUtilization/targetReadOpsPerSec": target_read_ops_per_sec "/appengine:v1beta4/DiskUtilization/targetWriteBytesPerSec": target_write_bytes_per_sec "/appengine:v1beta4/DiskUtilization/targetWriteOpsPerSec": target_write_ops_per_sec +"/appengine:v1beta4/EndpointsApiService": endpoints_api_service +"/appengine:v1beta4/EndpointsApiService/configId": config_id +"/appengine:v1beta4/EndpointsApiService/name": name "/appengine:v1beta4/ErrorHandler": error_handler "/appengine:v1beta4/ErrorHandler/errorCode": error_code "/appengine:v1beta4/ErrorHandler/mimeType": mime_type @@ -7937,6 +8192,7 @@ "/appengine:v1beta4/Version/defaultExpiration": default_expiration "/appengine:v1beta4/Version/deployer": deployer "/appengine:v1beta4/Version/deployment": deployment +"/appengine:v1beta4/Version/endpointsApiService": endpoints_api_service "/appengine:v1beta4/Version/env": env "/appengine:v1beta4/Version/envVariables": env_variables "/appengine:v1beta4/Version/envVariables/env_variable": env_variable @@ -8837,6 +9093,8 @@ "/bigquery:v2/JobStatistics2": job_statistics2 "/bigquery:v2/JobStatistics2/billingTier": billing_tier "/bigquery:v2/JobStatistics2/cacheHit": cache_hit +"/bigquery:v2/JobStatistics2/ddlOperationPerformed": ddl_operation_performed +"/bigquery:v2/JobStatistics2/ddlTargetTable": ddl_target_table "/bigquery:v2/JobStatistics2/numDmlAffectedRows": num_dml_affected_rows "/bigquery:v2/JobStatistics2/queryPlan": query_plan "/bigquery:v2/JobStatistics2/queryPlan/query_plan": query_plan @@ -9203,6 +9461,12 @@ "/bigquerydatatransfer:v1/ScheduleTransferRunsResponse/runs/run": run "/bigquerydatatransfer:v1/SetEnabledRequest": set_enabled_request "/bigquerydatatransfer:v1/SetEnabledRequest/enabled": enabled +"/bigquerydatatransfer:v1/Status": status +"/bigquerydatatransfer:v1/Status/code": code +"/bigquerydatatransfer:v1/Status/details": details +"/bigquerydatatransfer:v1/Status/details/detail": detail +"/bigquerydatatransfer:v1/Status/details/detail/detail": detail +"/bigquerydatatransfer:v1/Status/message": message "/bigquerydatatransfer:v1/TransferConfig": transfer_config "/bigquerydatatransfer:v1/TransferConfig/dataRefreshWindowDays": data_refresh_window_days "/bigquerydatatransfer:v1/TransferConfig/dataSourceId": data_source_id @@ -9228,6 +9492,7 @@ "/bigquerydatatransfer:v1/TransferRun/datasetRegion": dataset_region "/bigquerydatatransfer:v1/TransferRun/destinationDatasetId": destination_dataset_id "/bigquerydatatransfer:v1/TransferRun/endTime": end_time +"/bigquerydatatransfer:v1/TransferRun/errorStatus": error_status "/bigquerydatatransfer:v1/TransferRun/name": name "/bigquerydatatransfer:v1/TransferRun/params": params "/bigquerydatatransfer:v1/TransferRun/params/param": param @@ -10898,6 +11163,7 @@ "/calendar:v3/calendar.acl.get/ruleId": rule_id "/calendar:v3/calendar.acl.insert": insert_acl "/calendar:v3/calendar.acl.insert/calendarId": calendar_id +"/calendar:v3/calendar.acl.insert/sendNotifications": send_notifications "/calendar:v3/calendar.acl.list": list_acls "/calendar:v3/calendar.acl.list/calendarId": calendar_id "/calendar:v3/calendar.acl.list/maxResults": max_results @@ -10907,9 +11173,11 @@ "/calendar:v3/calendar.acl.patch": patch_acl "/calendar:v3/calendar.acl.patch/calendarId": calendar_id "/calendar:v3/calendar.acl.patch/ruleId": rule_id +"/calendar:v3/calendar.acl.patch/sendNotifications": send_notifications "/calendar:v3/calendar.acl.update": update_acl "/calendar:v3/calendar.acl.update/calendarId": calendar_id "/calendar:v3/calendar.acl.update/ruleId": rule_id +"/calendar:v3/calendar.acl.update/sendNotifications": send_notifications "/calendar:v3/calendar.acl.watch": watch_acl "/calendar:v3/calendar.acl.watch/calendarId": calendar_id "/calendar:v3/calendar.acl.watch/maxResults": max_results @@ -11883,6 +12151,9 @@ "/cloudbuild:v1/BuildOperationMetadata": build_operation_metadata "/cloudbuild:v1/BuildOperationMetadata/build": build "/cloudbuild:v1/BuildOptions": build_options +"/cloudbuild:v1/BuildOptions/diskSizeGb": disk_size_gb +"/cloudbuild:v1/BuildOptions/logStreamingOption": log_streaming_option +"/cloudbuild:v1/BuildOptions/machineType": machine_type "/cloudbuild:v1/BuildOptions/requestedVerifyOption": requested_verify_option "/cloudbuild:v1/BuildOptions/sourceProvenanceHash": source_provenance_hash "/cloudbuild:v1/BuildOptions/sourceProvenanceHash/source_provenance_hash": source_provenance_hash @@ -11946,6 +12217,7 @@ "/cloudbuild:v1/RepoSource": repo_source "/cloudbuild:v1/RepoSource/branchName": branch_name "/cloudbuild:v1/RepoSource/commitSha": commit_sha +"/cloudbuild:v1/RepoSource/dir": dir "/cloudbuild:v1/RepoSource/projectId": project_id "/cloudbuild:v1/RepoSource/repoName": repo_name "/cloudbuild:v1/RepoSource/tagName": tag_name @@ -11954,6 +12226,7 @@ "/cloudbuild:v1/Results/buildStepImages/build_step_image": build_step_image "/cloudbuild:v1/Results/images": images "/cloudbuild:v1/Results/images/image": image +"/cloudbuild:v1/RetryBuildRequest": retry_build_request "/cloudbuild:v1/Secret": secret "/cloudbuild:v1/Secret/kmsKeyName": kms_key_name "/cloudbuild:v1/Secret/secretEnv": secret_env @@ -12001,6 +12274,9 @@ "/cloudbuild:v1/cloudbuild.projects.builds.list/pageSize": page_size "/cloudbuild:v1/cloudbuild.projects.builds.list/pageToken": page_token "/cloudbuild:v1/cloudbuild.projects.builds.list/projectId": project_id +"/cloudbuild:v1/cloudbuild.projects.builds.retry": retry_build +"/cloudbuild:v1/cloudbuild.projects.builds.retry/id": id +"/cloudbuild:v1/cloudbuild.projects.builds.retry/projectId": project_id "/cloudbuild:v1/cloudbuild.projects.triggers.create": create_project_trigger "/cloudbuild:v1/cloudbuild.projects.triggers.create/projectId": project_id "/cloudbuild:v1/cloudbuild.projects.triggers.delete": delete_project_trigger @@ -12014,6 +12290,9 @@ "/cloudbuild:v1/cloudbuild.projects.triggers.patch": patch_project_trigger "/cloudbuild:v1/cloudbuild.projects.triggers.patch/projectId": project_id "/cloudbuild:v1/cloudbuild.projects.triggers.patch/triggerId": trigger_id +"/cloudbuild:v1/cloudbuild.projects.triggers.run": run_project_trigger +"/cloudbuild:v1/cloudbuild.projects.triggers.run/projectId": project_id +"/cloudbuild:v1/cloudbuild.projects.triggers.run/triggerId": trigger_id "/cloudbuild:v1/fields": fields "/cloudbuild:v1/key": key "/cloudbuild:v1/quotaUser": quota_user @@ -12278,6 +12557,49 @@ "/clouderrorreporting:v1beta1/fields": fields "/clouderrorreporting:v1beta1/key": key "/clouderrorreporting:v1beta1/quotaUser": quota_user +"/cloudfunctions:v1/CallFunctionRequest": call_function_request +"/cloudfunctions:v1/CallFunctionRequest/data": data +"/cloudfunctions:v1/CallFunctionResponse": call_function_response +"/cloudfunctions:v1/CallFunctionResponse/error": error +"/cloudfunctions:v1/CallFunctionResponse/executionId": execution_id +"/cloudfunctions:v1/CallFunctionResponse/result": result +"/cloudfunctions:v1/CloudFunction": cloud_function +"/cloudfunctions:v1/CloudFunction/availableMemoryMb": available_memory_mb +"/cloudfunctions:v1/CloudFunction/description": description +"/cloudfunctions:v1/CloudFunction/entryPoint": entry_point +"/cloudfunctions:v1/CloudFunction/eventTrigger": event_trigger +"/cloudfunctions:v1/CloudFunction/httpsTrigger": https_trigger +"/cloudfunctions:v1/CloudFunction/labels": labels +"/cloudfunctions:v1/CloudFunction/labels/label": label +"/cloudfunctions:v1/CloudFunction/name": name +"/cloudfunctions:v1/CloudFunction/serviceAccountEmail": service_account_email +"/cloudfunctions:v1/CloudFunction/sourceArchiveUrl": source_archive_url +"/cloudfunctions:v1/CloudFunction/sourceRepository": source_repository +"/cloudfunctions:v1/CloudFunction/sourceUploadUrl": source_upload_url +"/cloudfunctions:v1/CloudFunction/status": status +"/cloudfunctions:v1/CloudFunction/timeout": timeout +"/cloudfunctions:v1/CloudFunction/updateTime": update_time +"/cloudfunctions:v1/CloudFunction/versionId": version_id +"/cloudfunctions:v1/EventTrigger": event_trigger +"/cloudfunctions:v1/EventTrigger/eventType": event_type +"/cloudfunctions:v1/EventTrigger/failurePolicy": failure_policy +"/cloudfunctions:v1/EventTrigger/resource": resource +"/cloudfunctions:v1/EventTrigger/service": service +"/cloudfunctions:v1/FailurePolicy": failure_policy +"/cloudfunctions:v1/FailurePolicy/retry": retry +"/cloudfunctions:v1/GenerateDownloadUrlRequest": generate_download_url_request +"/cloudfunctions:v1/GenerateDownloadUrlRequest/versionId": version_id +"/cloudfunctions:v1/GenerateDownloadUrlResponse": generate_download_url_response +"/cloudfunctions:v1/GenerateDownloadUrlResponse/downloadUrl": download_url +"/cloudfunctions:v1/GenerateUploadUrlRequest": generate_upload_url_request +"/cloudfunctions:v1/GenerateUploadUrlResponse": generate_upload_url_response +"/cloudfunctions:v1/GenerateUploadUrlResponse/uploadUrl": upload_url +"/cloudfunctions:v1/HttpsTrigger": https_trigger +"/cloudfunctions:v1/HttpsTrigger/url": url +"/cloudfunctions:v1/ListFunctionsResponse": list_functions_response +"/cloudfunctions:v1/ListFunctionsResponse/functions": functions +"/cloudfunctions:v1/ListFunctionsResponse/functions/function": function +"/cloudfunctions:v1/ListFunctionsResponse/nextPageToken": next_page_token "/cloudfunctions:v1/ListLocationsResponse": list_locations_response "/cloudfunctions:v1/ListLocationsResponse/locations": locations "/cloudfunctions:v1/ListLocationsResponse/locations/location": location @@ -12301,12 +12623,24 @@ "/cloudfunctions:v1/Operation/name": name "/cloudfunctions:v1/Operation/response": response "/cloudfunctions:v1/Operation/response/response": response +"/cloudfunctions:v1/OperationMetadataV1": operation_metadata_v1 +"/cloudfunctions:v1/OperationMetadataV1/request": request +"/cloudfunctions:v1/OperationMetadataV1/request/request": request +"/cloudfunctions:v1/OperationMetadataV1/target": target +"/cloudfunctions:v1/OperationMetadataV1/type": type +"/cloudfunctions:v1/OperationMetadataV1/updateTime": update_time +"/cloudfunctions:v1/OperationMetadataV1/versionId": version_id "/cloudfunctions:v1/OperationMetadataV1Beta2": operation_metadata_v1_beta2 "/cloudfunctions:v1/OperationMetadataV1Beta2/request": request "/cloudfunctions:v1/OperationMetadataV1Beta2/request/request": request "/cloudfunctions:v1/OperationMetadataV1Beta2/target": target "/cloudfunctions:v1/OperationMetadataV1Beta2/type": type +"/cloudfunctions:v1/OperationMetadataV1Beta2/updateTime": update_time "/cloudfunctions:v1/OperationMetadataV1Beta2/versionId": version_id +"/cloudfunctions:v1/Retry": retry +"/cloudfunctions:v1/SourceRepository": source_repository +"/cloudfunctions:v1/SourceRepository/deployedUrl": deployed_url +"/cloudfunctions:v1/SourceRepository/url": url "/cloudfunctions:v1/Status": status "/cloudfunctions:v1/Status/code": code "/cloudfunctions:v1/Status/details": details @@ -12320,6 +12654,25 @@ "/cloudfunctions:v1/cloudfunctions.operations.list/name": name "/cloudfunctions:v1/cloudfunctions.operations.list/pageSize": page_size "/cloudfunctions:v1/cloudfunctions.operations.list/pageToken": page_token +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.call": call_function +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.call/name": name +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.create": create_project_location_function +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.create/location": location +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.delete": delete_project_location_function +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.delete/name": name +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.generateDownloadUrl": generate_function_download_url +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.generateDownloadUrl/name": name +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.generateUploadUrl": generate_function_upload_url +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.generateUploadUrl/parent": parent +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.get": get_project_location_function +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.get/name": name +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.list": list_project_location_functions +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.list/pageSize": page_size +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.list/pageToken": page_token +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.list/parent": parent +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.patch": patch_project_location_function +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.patch/name": name +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.patch/updateMask": update_mask "/cloudfunctions:v1/cloudfunctions.projects.locations.list": list_project_locations "/cloudfunctions:v1/cloudfunctions.projects.locations.list/filter": filter "/cloudfunctions:v1/cloudfunctions.projects.locations.list/name": name @@ -12347,6 +12700,7 @@ "/cloudfunctions:v1beta2/CloudFunction/sourceArchiveUrl": source_archive_url "/cloudfunctions:v1beta2/CloudFunction/sourceRepository": source_repository "/cloudfunctions:v1beta2/CloudFunction/sourceRepositoryUrl": source_repository_url +"/cloudfunctions:v1beta2/CloudFunction/sourceUploadUrl": source_upload_url "/cloudfunctions:v1beta2/CloudFunction/status": status "/cloudfunctions:v1beta2/CloudFunction/timeout": timeout "/cloudfunctions:v1beta2/CloudFunction/updateTime": update_time @@ -12358,6 +12712,13 @@ "/cloudfunctions:v1beta2/EventTrigger/service": service "/cloudfunctions:v1beta2/FailurePolicy": failure_policy "/cloudfunctions:v1beta2/FailurePolicy/retry": retry +"/cloudfunctions:v1beta2/GenerateDownloadUrlRequest": generate_download_url_request +"/cloudfunctions:v1beta2/GenerateDownloadUrlRequest/versionId": version_id +"/cloudfunctions:v1beta2/GenerateDownloadUrlResponse": generate_download_url_response +"/cloudfunctions:v1beta2/GenerateDownloadUrlResponse/downloadUrl": download_url +"/cloudfunctions:v1beta2/GenerateUploadUrlRequest": generate_upload_url_request +"/cloudfunctions:v1beta2/GenerateUploadUrlResponse": generate_upload_url_response +"/cloudfunctions:v1beta2/GenerateUploadUrlResponse/uploadUrl": upload_url "/cloudfunctions:v1beta2/HTTPSTrigger": https_trigger "/cloudfunctions:v1beta2/HTTPSTrigger/url": url "/cloudfunctions:v1beta2/ListFunctionsResponse": list_functions_response @@ -12387,11 +12748,19 @@ "/cloudfunctions:v1beta2/Operation/name": name "/cloudfunctions:v1beta2/Operation/response": response "/cloudfunctions:v1beta2/Operation/response/response": response +"/cloudfunctions:v1beta2/OperationMetadataV1": operation_metadata_v1 +"/cloudfunctions:v1beta2/OperationMetadataV1/request": request +"/cloudfunctions:v1beta2/OperationMetadataV1/request/request": request +"/cloudfunctions:v1beta2/OperationMetadataV1/target": target +"/cloudfunctions:v1beta2/OperationMetadataV1/type": type +"/cloudfunctions:v1beta2/OperationMetadataV1/updateTime": update_time +"/cloudfunctions:v1beta2/OperationMetadataV1/versionId": version_id "/cloudfunctions:v1beta2/OperationMetadataV1Beta2": operation_metadata_v1_beta2 "/cloudfunctions:v1beta2/OperationMetadataV1Beta2/request": request "/cloudfunctions:v1beta2/OperationMetadataV1Beta2/request/request": request "/cloudfunctions:v1beta2/OperationMetadataV1Beta2/target": target "/cloudfunctions:v1beta2/OperationMetadataV1Beta2/type": type +"/cloudfunctions:v1beta2/OperationMetadataV1Beta2/updateTime": update_time "/cloudfunctions:v1beta2/OperationMetadataV1Beta2/versionId": version_id "/cloudfunctions:v1beta2/Retry": retry "/cloudfunctions:v1beta2/SourceRepository": source_repository @@ -12420,6 +12789,10 @@ "/cloudfunctions:v1beta2/cloudfunctions.projects.locations.functions.create/location": location "/cloudfunctions:v1beta2/cloudfunctions.projects.locations.functions.delete": delete_project_location_function "/cloudfunctions:v1beta2/cloudfunctions.projects.locations.functions.delete/name": name +"/cloudfunctions:v1beta2/cloudfunctions.projects.locations.functions.generateDownloadUrl": generate_function_download_url +"/cloudfunctions:v1beta2/cloudfunctions.projects.locations.functions.generateDownloadUrl/name": name +"/cloudfunctions:v1beta2/cloudfunctions.projects.locations.functions.generateUploadUrl": generate_function_upload_url +"/cloudfunctions:v1beta2/cloudfunctions.projects.locations.functions.generateUploadUrl/parent": parent "/cloudfunctions:v1beta2/cloudfunctions.projects.locations.functions.get": get_project_location_function "/cloudfunctions:v1beta2/cloudfunctions.projects.locations.functions.get/name": name "/cloudfunctions:v1beta2/cloudfunctions.projects.locations.functions.list": list_project_location_functions @@ -12573,6 +12946,7 @@ "/cloudiot:v1/cloudiot.projects.locations.registries.devices.delete": delete_project_location_registry_device "/cloudiot:v1/cloudiot.projects.locations.registries.devices.delete/name": name "/cloudiot:v1/cloudiot.projects.locations.registries.devices.get": get_project_location_registry_device +"/cloudiot:v1/cloudiot.projects.locations.registries.devices.get/fieldMask": field_mask "/cloudiot:v1/cloudiot.projects.locations.registries.devices.get/name": name "/cloudiot:v1/cloudiot.projects.locations.registries.devices.list": list_project_location_registry_devices "/cloudiot:v1/cloudiot.projects.locations.registries.devices.list/deviceIds": device_ids @@ -13632,12 +14006,14 @@ "/cloudtasks:v2beta2/Queue/queueState": queue_state "/cloudtasks:v2beta2/Queue/rateLimits": rate_limits "/cloudtasks:v2beta2/Queue/retryConfig": retry_config +"/cloudtasks:v2beta2/Queue/state": state "/cloudtasks:v2beta2/Queue/throttleConfig": throttle_config "/cloudtasks:v2beta2/RateLimits": rate_limits "/cloudtasks:v2beta2/RateLimits/maxBurstSize": max_burst_size "/cloudtasks:v2beta2/RateLimits/maxConcurrentTasks": max_concurrent_tasks "/cloudtasks:v2beta2/RateLimits/maxTasksDispatchedPerSecond": max_tasks_dispatched_per_second "/cloudtasks:v2beta2/RenewLeaseRequest": renew_lease_request +"/cloudtasks:v2beta2/RenewLeaseRequest/leaseDuration": lease_duration "/cloudtasks:v2beta2/RenewLeaseRequest/newLeaseDuration": new_lease_duration "/cloudtasks:v2beta2/RenewLeaseRequest/responseView": response_view "/cloudtasks:v2beta2/RenewLeaseRequest/scheduleTime": schedule_time @@ -13817,9 +14193,11 @@ "/cloudtrace:v2/ListTracesResponse/traces/trace": trace "/cloudtrace:v2/MessageEvent": message_event "/cloudtrace:v2/MessageEvent/compressedSize": compressed_size +"/cloudtrace:v2/MessageEvent/compressedSizeBytes": compressed_size_bytes "/cloudtrace:v2/MessageEvent/id": id "/cloudtrace:v2/MessageEvent/type": type "/cloudtrace:v2/MessageEvent/uncompressedSize": uncompressed_size +"/cloudtrace:v2/MessageEvent/uncompressedSizeBytes": uncompressed_size_bytes "/cloudtrace:v2/Module": module "/cloudtrace:v2/Module/buildId": build_id "/cloudtrace:v2/Module/module": module @@ -15254,6 +15632,8 @@ "/compute:alpha/Disk/creationTimestamp": creation_timestamp "/compute:alpha/Disk/description": description "/compute:alpha/Disk/diskEncryptionKey": disk_encryption_key +"/compute:alpha/Disk/guestOsFeatures": guest_os_features +"/compute:alpha/Disk/guestOsFeatures/guest_os_feature": guest_os_feature "/compute:alpha/Disk/id": id "/compute:alpha/Disk/kind": kind "/compute:alpha/Disk/labelFingerprint": label_fingerprint @@ -15408,6 +15788,7 @@ "/compute:alpha/Firewall/destinationRanges": destination_ranges "/compute:alpha/Firewall/destinationRanges/destination_range": destination_range "/compute:alpha/Firewall/direction": direction +"/compute:alpha/Firewall/disabled": disabled "/compute:alpha/Firewall/enableLogging": enable_logging "/compute:alpha/Firewall/id": id "/compute:alpha/Firewall/kind": kind @@ -15819,6 +16200,8 @@ "/compute:alpha/Instance/labels": labels "/compute:alpha/Instance/labels/label": label "/compute:alpha/Instance/machineType": machine_type +"/compute:alpha/Instance/maintenancePolicies": maintenance_policies +"/compute:alpha/Instance/maintenancePolicies/maintenance_policy": maintenance_policy "/compute:alpha/Instance/metadata": metadata "/compute:alpha/Instance/minCpuPlatform": min_cpu_platform "/compute:alpha/Instance/name": name @@ -17187,6 +17570,7 @@ "/compute:alpha/SecurityPolicyRule/priority": priority "/compute:alpha/SecurityPolicyRuleMatcher": security_policy_rule_matcher "/compute:alpha/SecurityPolicyRuleMatcher/config": config +"/compute:alpha/SecurityPolicyRuleMatcher/expr": expr "/compute:alpha/SecurityPolicyRuleMatcher/srcIpRanges": src_ip_ranges "/compute:alpha/SecurityPolicyRuleMatcher/srcIpRanges/src_ip_range": src_ip_range "/compute:alpha/SecurityPolicyRuleMatcher/srcRegionCodes": src_region_codes @@ -17311,6 +17695,15 @@ "/compute:alpha/SslPolicy/warnings/warning/message": message "/compute:alpha/SslPolicyReference": ssl_policy_reference "/compute:alpha/SslPolicyReference/sslPolicy": ssl_policy +"/compute:alpha/StatefulPolicy": stateful_policy +"/compute:alpha/StatefulPolicy/preservedDisks": preserved_disks +"/compute:alpha/StatefulPolicy/preservedDisks/preserved_disk": preserved_disk +"/compute:alpha/StatefulPolicy/preservedResources": preserved_resources +"/compute:alpha/StatefulPolicyPreservedDisk": stateful_policy_preserved_disk +"/compute:alpha/StatefulPolicyPreservedDisk/deviceName": device_name +"/compute:alpha/StatefulPolicyPreservedResources": stateful_policy_preserved_resources +"/compute:alpha/StatefulPolicyPreservedResources/disks": disks +"/compute:alpha/StatefulPolicyPreservedResources/disks/disk": disk "/compute:alpha/Subnetwork": subnetwork "/compute:alpha/Subnetwork/allowSubnetCidrRoutesOverlap": allow_subnet_cidr_routes_overlap "/compute:alpha/Subnetwork/creationTimestamp": creation_timestamp @@ -19437,6 +19830,9 @@ "/compute:alpha/compute.routes.testIamPermissions": test_route_iam_permissions "/compute:alpha/compute.routes.testIamPermissions/project": project "/compute:alpha/compute.routes.testIamPermissions/resource": resource +"/compute:alpha/compute.securityPolicies.addRule": add_security_policy_rule +"/compute:alpha/compute.securityPolicies.addRule/project": project +"/compute:alpha/compute.securityPolicies.addRule/securityPolicy": security_policy "/compute:alpha/compute.securityPolicies.delete": delete_security_policy "/compute:alpha/compute.securityPolicies.delete/project": project "/compute:alpha/compute.securityPolicies.delete/requestId": request_id @@ -19444,6 +19840,10 @@ "/compute:alpha/compute.securityPolicies.get": get_security_policy "/compute:alpha/compute.securityPolicies.get/project": project "/compute:alpha/compute.securityPolicies.get/securityPolicy": security_policy +"/compute:alpha/compute.securityPolicies.getRule": get_security_policy_rule +"/compute:alpha/compute.securityPolicies.getRule/priority": priority +"/compute:alpha/compute.securityPolicies.getRule/project": project +"/compute:alpha/compute.securityPolicies.getRule/securityPolicy": security_policy "/compute:alpha/compute.securityPolicies.insert": insert_security_policy "/compute:alpha/compute.securityPolicies.insert/project": project "/compute:alpha/compute.securityPolicies.insert/requestId": request_id @@ -19457,6 +19857,14 @@ "/compute:alpha/compute.securityPolicies.patch/project": project "/compute:alpha/compute.securityPolicies.patch/requestId": request_id "/compute:alpha/compute.securityPolicies.patch/securityPolicy": security_policy +"/compute:alpha/compute.securityPolicies.patchRule": patch_security_policy_rule +"/compute:alpha/compute.securityPolicies.patchRule/priority": priority +"/compute:alpha/compute.securityPolicies.patchRule/project": project +"/compute:alpha/compute.securityPolicies.patchRule/securityPolicy": security_policy +"/compute:alpha/compute.securityPolicies.removeRule": remove_security_policy_rule +"/compute:alpha/compute.securityPolicies.removeRule/priority": priority +"/compute:alpha/compute.securityPolicies.removeRule/project": project +"/compute:alpha/compute.securityPolicies.removeRule/securityPolicy": security_policy "/compute:alpha/compute.securityPolicies.testIamPermissions": test_security_policy_iam_permissions "/compute:alpha/compute.securityPolicies.testIamPermissions/project": project "/compute:alpha/compute.securityPolicies.testIamPermissions/resource": resource @@ -20367,6 +20775,8 @@ "/compute:beta/Disk/labels/label": label "/compute:beta/Disk/lastAttachTimestamp": last_attach_timestamp "/compute:beta/Disk/lastDetachTimestamp": last_detach_timestamp +"/compute:beta/Disk/licenseCodes": license_codes +"/compute:beta/Disk/licenseCodes/license_code": license_code "/compute:beta/Disk/licenses": licenses "/compute:beta/Disk/licenses/license": license "/compute:beta/Disk/name": name @@ -20733,6 +21143,8 @@ "/compute:beta/Image/labelFingerprint": label_fingerprint "/compute:beta/Image/labels": labels "/compute:beta/Image/labels/label": label +"/compute:beta/Image/licenseCodes": license_codes +"/compute:beta/Image/licenseCodes/license_code": license_code "/compute:beta/Image/licenses": licenses "/compute:beta/Image/licenses/license": license "/compute:beta/Image/name": name @@ -20767,6 +21179,7 @@ "/compute:beta/Instance/canIpForward": can_ip_forward "/compute:beta/Instance/cpuPlatform": cpu_platform "/compute:beta/Instance/creationTimestamp": creation_timestamp +"/compute:beta/Instance/deletionProtection": deletion_protection "/compute:beta/Instance/description": description "/compute:beta/Instance/disks": disks "/compute:beta/Instance/disks/disk": disk @@ -21256,9 +21669,45 @@ "/compute:beta/InterconnectOutageNotification/state": state "/compute:beta/License": license "/compute:beta/License/chargesUseFee": charges_use_fee +"/compute:beta/License/creationTimestamp": creation_timestamp +"/compute:beta/License/description": description +"/compute:beta/License/id": id "/compute:beta/License/kind": kind +"/compute:beta/License/licenseCode": license_code "/compute:beta/License/name": name +"/compute:beta/License/resourceRequirements": resource_requirements "/compute:beta/License/selfLink": self_link +"/compute:beta/License/transferable": transferable +"/compute:beta/LicenseCode": license_code +"/compute:beta/LicenseCode/creationTimestamp": creation_timestamp +"/compute:beta/LicenseCode/description": description +"/compute:beta/LicenseCode/id": id +"/compute:beta/LicenseCode/kind": kind +"/compute:beta/LicenseCode/licenseAlias": license_alias +"/compute:beta/LicenseCode/licenseAlias/license_alias": license_alias +"/compute:beta/LicenseCode/name": name +"/compute:beta/LicenseCode/selfLink": self_link +"/compute:beta/LicenseCode/state": state +"/compute:beta/LicenseCode/transferable": transferable +"/compute:beta/LicenseCodeLicenseAlias": license_code_license_alias +"/compute:beta/LicenseCodeLicenseAlias/description": description +"/compute:beta/LicenseCodeLicenseAlias/selfLink": self_link +"/compute:beta/LicenseResourceRequirements": license_resource_requirements +"/compute:beta/LicenseResourceRequirements/minGuestCpuCount": min_guest_cpu_count +"/compute:beta/LicenseResourceRequirements/minMemoryMb": min_memory_mb +"/compute:beta/LicensesListResponse": licenses_list_response +"/compute:beta/LicensesListResponse/id": id +"/compute:beta/LicensesListResponse/items": items +"/compute:beta/LicensesListResponse/items/item": item +"/compute:beta/LicensesListResponse/nextPageToken": next_page_token +"/compute:beta/LicensesListResponse/selfLink": self_link +"/compute:beta/LicensesListResponse/warning": warning +"/compute:beta/LicensesListResponse/warning/code": code +"/compute:beta/LicensesListResponse/warning/data": data +"/compute:beta/LicensesListResponse/warning/data/datum": datum +"/compute:beta/LicensesListResponse/warning/data/datum/key": key +"/compute:beta/LicensesListResponse/warning/data/datum/value": value +"/compute:beta/LicensesListResponse/warning/message": message "/compute:beta/LogConfig": log_config "/compute:beta/LogConfig/cloudAudit": cloud_audit "/compute:beta/LogConfig/counter": counter @@ -21868,6 +22317,8 @@ "/compute:beta/Snapshot/labelFingerprint": label_fingerprint "/compute:beta/Snapshot/labels": labels "/compute:beta/Snapshot/labels/label": label +"/compute:beta/Snapshot/licenseCodes": license_codes +"/compute:beta/Snapshot/licenseCodes/license_code": license_code "/compute:beta/Snapshot/licenses": licenses "/compute:beta/Snapshot/licenses/license": license "/compute:beta/Snapshot/name": name @@ -23132,6 +23583,12 @@ "/compute:beta/compute.instances.reset/project": project "/compute:beta/compute.instances.reset/requestId": request_id "/compute:beta/compute.instances.reset/zone": zone +"/compute:beta/compute.instances.setDeletionProtection": set_instance_deletion_protection +"/compute:beta/compute.instances.setDeletionProtection/deletionProtection": deletion_protection +"/compute:beta/compute.instances.setDeletionProtection/project": project +"/compute:beta/compute.instances.setDeletionProtection/requestId": request_id +"/compute:beta/compute.instances.setDeletionProtection/resource": resource +"/compute:beta/compute.instances.setDeletionProtection/zone": zone "/compute:beta/compute.instances.setDiskAutoDelete": set_disk_auto_delete "/compute:beta/compute.instances.setDiskAutoDelete/autoDelete": auto_delete "/compute:beta/compute.instances.setDiskAutoDelete/deviceName": device_name @@ -23272,9 +23729,25 @@ "/compute:beta/compute.interconnects.testIamPermissions": test_interconnect_iam_permissions "/compute:beta/compute.interconnects.testIamPermissions/project": project "/compute:beta/compute.interconnects.testIamPermissions/resource": resource +"/compute:beta/compute.licenseCodes.get": get_license_code +"/compute:beta/compute.licenseCodes.get/licenseCode": license_code +"/compute:beta/compute.licenseCodes.get/project": project +"/compute:beta/compute.licenses.delete": delete_license +"/compute:beta/compute.licenses.delete/license": license +"/compute:beta/compute.licenses.delete/project": project +"/compute:beta/compute.licenses.delete/requestId": request_id "/compute:beta/compute.licenses.get": get_license "/compute:beta/compute.licenses.get/license": license "/compute:beta/compute.licenses.get/project": project +"/compute:beta/compute.licenses.insert": insert_license +"/compute:beta/compute.licenses.insert/project": project +"/compute:beta/compute.licenses.insert/requestId": request_id +"/compute:beta/compute.licenses.list": list_licenses +"/compute:beta/compute.licenses.list/filter": filter +"/compute:beta/compute.licenses.list/maxResults": max_results +"/compute:beta/compute.licenses.list/orderBy": order_by +"/compute:beta/compute.licenses.list/pageToken": page_token +"/compute:beta/compute.licenses.list/project": project "/compute:beta/compute.machineTypes.aggregatedList": list_aggregated_machine_types "/compute:beta/compute.machineTypes.aggregatedList/filter": filter "/compute:beta/compute.machineTypes.aggregatedList/maxResults": max_results @@ -24619,8 +25092,12 @@ "/compute:v1/Firewall/selfLink": self_link "/compute:v1/Firewall/sourceRanges": source_ranges "/compute:v1/Firewall/sourceRanges/source_range": source_range +"/compute:v1/Firewall/sourceServiceAccounts": source_service_accounts +"/compute:v1/Firewall/sourceServiceAccounts/source_service_account": source_service_account "/compute:v1/Firewall/sourceTags": source_tags "/compute:v1/Firewall/sourceTags/source_tag": source_tag +"/compute:v1/Firewall/targetServiceAccounts": target_service_accounts +"/compute:v1/Firewall/targetServiceAccounts/target_service_account": target_service_account "/compute:v1/Firewall/targetTags": target_tags "/compute:v1/Firewall/targetTags/target_tag": target_tag "/compute:v1/FirewallList": firewall_list @@ -24859,6 +25336,7 @@ "/compute:v1/Instance/canIpForward": can_ip_forward "/compute:v1/Instance/cpuPlatform": cpu_platform "/compute:v1/Instance/creationTimestamp": creation_timestamp +"/compute:v1/Instance/deletionProtection": deletion_protection "/compute:v1/Instance/description": description "/compute:v1/Instance/disks": disks "/compute:v1/Instance/disks/disk": disk @@ -25153,6 +25631,148 @@ "/compute:v1/InstancesStartWithEncryptionKeyRequest": instances_start_with_encryption_key_request "/compute:v1/InstancesStartWithEncryptionKeyRequest/disks": disks "/compute:v1/InstancesStartWithEncryptionKeyRequest/disks/disk": disk +"/compute:v1/Interconnect": interconnect +"/compute:v1/Interconnect/adminEnabled": admin_enabled +"/compute:v1/Interconnect/circuitInfos": circuit_infos +"/compute:v1/Interconnect/circuitInfos/circuit_info": circuit_info +"/compute:v1/Interconnect/creationTimestamp": creation_timestamp +"/compute:v1/Interconnect/customerName": customer_name +"/compute:v1/Interconnect/description": description +"/compute:v1/Interconnect/expectedOutages": expected_outages +"/compute:v1/Interconnect/expectedOutages/expected_outage": expected_outage +"/compute:v1/Interconnect/googleIpAddress": google_ip_address +"/compute:v1/Interconnect/googleReferenceId": google_reference_id +"/compute:v1/Interconnect/id": id +"/compute:v1/Interconnect/interconnectAttachments": interconnect_attachments +"/compute:v1/Interconnect/interconnectAttachments/interconnect_attachment": interconnect_attachment +"/compute:v1/Interconnect/interconnectType": interconnect_type +"/compute:v1/Interconnect/kind": kind +"/compute:v1/Interconnect/linkType": link_type +"/compute:v1/Interconnect/location": location +"/compute:v1/Interconnect/name": name +"/compute:v1/Interconnect/nocContactEmail": noc_contact_email +"/compute:v1/Interconnect/operationalStatus": operational_status +"/compute:v1/Interconnect/peerIpAddress": peer_ip_address +"/compute:v1/Interconnect/provisionedLinkCount": provisioned_link_count +"/compute:v1/Interconnect/requestedLinkCount": requested_link_count +"/compute:v1/Interconnect/selfLink": self_link +"/compute:v1/InterconnectAttachment": interconnect_attachment +"/compute:v1/InterconnectAttachment/cloudRouterIpAddress": cloud_router_ip_address +"/compute:v1/InterconnectAttachment/creationTimestamp": creation_timestamp +"/compute:v1/InterconnectAttachment/customerRouterIpAddress": customer_router_ip_address +"/compute:v1/InterconnectAttachment/description": description +"/compute:v1/InterconnectAttachment/googleReferenceId": google_reference_id +"/compute:v1/InterconnectAttachment/id": id +"/compute:v1/InterconnectAttachment/interconnect": interconnect +"/compute:v1/InterconnectAttachment/kind": kind +"/compute:v1/InterconnectAttachment/name": name +"/compute:v1/InterconnectAttachment/operationalStatus": operational_status +"/compute:v1/InterconnectAttachment/privateInterconnectInfo": private_interconnect_info +"/compute:v1/InterconnectAttachment/region": region +"/compute:v1/InterconnectAttachment/router": router +"/compute:v1/InterconnectAttachment/selfLink": self_link +"/compute:v1/InterconnectAttachmentAggregatedList": interconnect_attachment_aggregated_list +"/compute:v1/InterconnectAttachmentAggregatedList/id": id +"/compute:v1/InterconnectAttachmentAggregatedList/items": items +"/compute:v1/InterconnectAttachmentAggregatedList/items/item": item +"/compute:v1/InterconnectAttachmentAggregatedList/kind": kind +"/compute:v1/InterconnectAttachmentAggregatedList/nextPageToken": next_page_token +"/compute:v1/InterconnectAttachmentAggregatedList/selfLink": self_link +"/compute:v1/InterconnectAttachmentAggregatedList/warning": warning +"/compute:v1/InterconnectAttachmentAggregatedList/warning/code": code +"/compute:v1/InterconnectAttachmentAggregatedList/warning/data": data +"/compute:v1/InterconnectAttachmentAggregatedList/warning/data/datum": datum +"/compute:v1/InterconnectAttachmentAggregatedList/warning/data/datum/key": key +"/compute:v1/InterconnectAttachmentAggregatedList/warning/data/datum/value": value +"/compute:v1/InterconnectAttachmentAggregatedList/warning/message": message +"/compute:v1/InterconnectAttachmentList": interconnect_attachment_list +"/compute:v1/InterconnectAttachmentList/id": id +"/compute:v1/InterconnectAttachmentList/items": items +"/compute:v1/InterconnectAttachmentList/items/item": item +"/compute:v1/InterconnectAttachmentList/kind": kind +"/compute:v1/InterconnectAttachmentList/nextPageToken": next_page_token +"/compute:v1/InterconnectAttachmentList/selfLink": self_link +"/compute:v1/InterconnectAttachmentList/warning": warning +"/compute:v1/InterconnectAttachmentList/warning/code": code +"/compute:v1/InterconnectAttachmentList/warning/data": data +"/compute:v1/InterconnectAttachmentList/warning/data/datum": datum +"/compute:v1/InterconnectAttachmentList/warning/data/datum/key": key +"/compute:v1/InterconnectAttachmentList/warning/data/datum/value": value +"/compute:v1/InterconnectAttachmentList/warning/message": message +"/compute:v1/InterconnectAttachmentPrivateInfo": interconnect_attachment_private_info +"/compute:v1/InterconnectAttachmentPrivateInfo/tag8021q": tag8021q +"/compute:v1/InterconnectAttachmentsScopedList": interconnect_attachments_scoped_list +"/compute:v1/InterconnectAttachmentsScopedList/interconnectAttachments": interconnect_attachments +"/compute:v1/InterconnectAttachmentsScopedList/interconnectAttachments/interconnect_attachment": interconnect_attachment +"/compute:v1/InterconnectAttachmentsScopedList/warning": warning +"/compute:v1/InterconnectAttachmentsScopedList/warning/code": code +"/compute:v1/InterconnectAttachmentsScopedList/warning/data": data +"/compute:v1/InterconnectAttachmentsScopedList/warning/data/datum": datum +"/compute:v1/InterconnectAttachmentsScopedList/warning/data/datum/key": key +"/compute:v1/InterconnectAttachmentsScopedList/warning/data/datum/value": value +"/compute:v1/InterconnectAttachmentsScopedList/warning/message": message +"/compute:v1/InterconnectCircuitInfo": interconnect_circuit_info +"/compute:v1/InterconnectCircuitInfo/customerDemarcId": customer_demarc_id +"/compute:v1/InterconnectCircuitInfo/googleCircuitId": google_circuit_id +"/compute:v1/InterconnectCircuitInfo/googleDemarcId": google_demarc_id +"/compute:v1/InterconnectList": interconnect_list +"/compute:v1/InterconnectList/id": id +"/compute:v1/InterconnectList/items": items +"/compute:v1/InterconnectList/items/item": item +"/compute:v1/InterconnectList/kind": kind +"/compute:v1/InterconnectList/nextPageToken": next_page_token +"/compute:v1/InterconnectList/selfLink": self_link +"/compute:v1/InterconnectList/warning": warning +"/compute:v1/InterconnectList/warning/code": code +"/compute:v1/InterconnectList/warning/data": data +"/compute:v1/InterconnectList/warning/data/datum": datum +"/compute:v1/InterconnectList/warning/data/datum/key": key +"/compute:v1/InterconnectList/warning/data/datum/value": value +"/compute:v1/InterconnectList/warning/message": message +"/compute:v1/InterconnectLocation": interconnect_location +"/compute:v1/InterconnectLocation/address": address +"/compute:v1/InterconnectLocation/availabilityZone": availability_zone +"/compute:v1/InterconnectLocation/city": city +"/compute:v1/InterconnectLocation/continent": continent +"/compute:v1/InterconnectLocation/creationTimestamp": creation_timestamp +"/compute:v1/InterconnectLocation/description": description +"/compute:v1/InterconnectLocation/facilityProvider": facility_provider +"/compute:v1/InterconnectLocation/facilityProviderFacilityId": facility_provider_facility_id +"/compute:v1/InterconnectLocation/id": id +"/compute:v1/InterconnectLocation/kind": kind +"/compute:v1/InterconnectLocation/name": name +"/compute:v1/InterconnectLocation/peeringdbFacilityId": peeringdb_facility_id +"/compute:v1/InterconnectLocation/regionInfos": region_infos +"/compute:v1/InterconnectLocation/regionInfos/region_info": region_info +"/compute:v1/InterconnectLocation/selfLink": self_link +"/compute:v1/InterconnectLocationList": interconnect_location_list +"/compute:v1/InterconnectLocationList/id": id +"/compute:v1/InterconnectLocationList/items": items +"/compute:v1/InterconnectLocationList/items/item": item +"/compute:v1/InterconnectLocationList/kind": kind +"/compute:v1/InterconnectLocationList/nextPageToken": next_page_token +"/compute:v1/InterconnectLocationList/selfLink": self_link +"/compute:v1/InterconnectLocationList/warning": warning +"/compute:v1/InterconnectLocationList/warning/code": code +"/compute:v1/InterconnectLocationList/warning/data": data +"/compute:v1/InterconnectLocationList/warning/data/datum": datum +"/compute:v1/InterconnectLocationList/warning/data/datum/key": key +"/compute:v1/InterconnectLocationList/warning/data/datum/value": value +"/compute:v1/InterconnectLocationList/warning/message": message +"/compute:v1/InterconnectLocationRegionInfo": interconnect_location_region_info +"/compute:v1/InterconnectLocationRegionInfo/expectedRttMs": expected_rtt_ms +"/compute:v1/InterconnectLocationRegionInfo/locationPresence": location_presence +"/compute:v1/InterconnectLocationRegionInfo/region": region +"/compute:v1/InterconnectOutageNotification": interconnect_outage_notification +"/compute:v1/InterconnectOutageNotification/affectedCircuits": affected_circuits +"/compute:v1/InterconnectOutageNotification/affectedCircuits/affected_circuit": affected_circuit +"/compute:v1/InterconnectOutageNotification/description": description +"/compute:v1/InterconnectOutageNotification/endTime": end_time +"/compute:v1/InterconnectOutageNotification/issueType": issue_type +"/compute:v1/InterconnectOutageNotification/name": name +"/compute:v1/InterconnectOutageNotification/source": source +"/compute:v1/InterconnectOutageNotification/startTime": start_time +"/compute:v1/InterconnectOutageNotification/state": state "/compute:v1/License": license "/compute:v1/License/chargesUseFee": charges_use_fee "/compute:v1/License/kind": kind @@ -25596,6 +26216,7 @@ "/compute:v1/RouterBgpPeer/peerIpAddress": peer_ip_address "/compute:v1/RouterInterface": router_interface "/compute:v1/RouterInterface/ipRange": ip_range +"/compute:v1/RouterInterface/linkedInterconnectAttachment": linked_interconnect_attachment "/compute:v1/RouterInterface/linkedVpnTunnel": linked_vpn_tunnel "/compute:v1/RouterInterface/name": name "/compute:v1/RouterList": router_list @@ -26827,6 +27448,12 @@ "/compute:v1/compute.instances.reset/project": project "/compute:v1/compute.instances.reset/requestId": request_id "/compute:v1/compute.instances.reset/zone": zone +"/compute:v1/compute.instances.setDeletionProtection": set_instance_deletion_protection +"/compute:v1/compute.instances.setDeletionProtection/deletionProtection": deletion_protection +"/compute:v1/compute.instances.setDeletionProtection/project": project +"/compute:v1/compute.instances.setDeletionProtection/requestId": request_id +"/compute:v1/compute.instances.setDeletionProtection/resource": resource +"/compute:v1/compute.instances.setDeletionProtection/zone": zone "/compute:v1/compute.instances.setDiskAutoDelete": set_disk_auto_delete "/compute:v1/compute.instances.setDiskAutoDelete/autoDelete": auto_delete "/compute:v1/compute.instances.setDiskAutoDelete/deviceName": device_name @@ -26889,6 +27516,61 @@ "/compute:v1/compute.instances.stop/project": project "/compute:v1/compute.instances.stop/requestId": request_id "/compute:v1/compute.instances.stop/zone": zone +"/compute:v1/compute.interconnectAttachments.aggregatedList": aggregated_interconnect_attachment_list +"/compute:v1/compute.interconnectAttachments.aggregatedList/filter": filter +"/compute:v1/compute.interconnectAttachments.aggregatedList/maxResults": max_results +"/compute:v1/compute.interconnectAttachments.aggregatedList/orderBy": order_by +"/compute:v1/compute.interconnectAttachments.aggregatedList/pageToken": page_token +"/compute:v1/compute.interconnectAttachments.aggregatedList/project": project +"/compute:v1/compute.interconnectAttachments.delete": delete_interconnect_attachment +"/compute:v1/compute.interconnectAttachments.delete/interconnectAttachment": interconnect_attachment +"/compute:v1/compute.interconnectAttachments.delete/project": project +"/compute:v1/compute.interconnectAttachments.delete/region": region +"/compute:v1/compute.interconnectAttachments.delete/requestId": request_id +"/compute:v1/compute.interconnectAttachments.get": get_interconnect_attachment +"/compute:v1/compute.interconnectAttachments.get/interconnectAttachment": interconnect_attachment +"/compute:v1/compute.interconnectAttachments.get/project": project +"/compute:v1/compute.interconnectAttachments.get/region": region +"/compute:v1/compute.interconnectAttachments.insert": insert_interconnect_attachment +"/compute:v1/compute.interconnectAttachments.insert/project": project +"/compute:v1/compute.interconnectAttachments.insert/region": region +"/compute:v1/compute.interconnectAttachments.insert/requestId": request_id +"/compute:v1/compute.interconnectAttachments.list": list_interconnect_attachments +"/compute:v1/compute.interconnectAttachments.list/filter": filter +"/compute:v1/compute.interconnectAttachments.list/maxResults": max_results +"/compute:v1/compute.interconnectAttachments.list/orderBy": order_by +"/compute:v1/compute.interconnectAttachments.list/pageToken": page_token +"/compute:v1/compute.interconnectAttachments.list/project": project +"/compute:v1/compute.interconnectAttachments.list/region": region +"/compute:v1/compute.interconnectLocations.get": get_interconnect_location +"/compute:v1/compute.interconnectLocations.get/interconnectLocation": interconnect_location +"/compute:v1/compute.interconnectLocations.get/project": project +"/compute:v1/compute.interconnectLocations.list": list_interconnect_locations +"/compute:v1/compute.interconnectLocations.list/filter": filter +"/compute:v1/compute.interconnectLocations.list/maxResults": max_results +"/compute:v1/compute.interconnectLocations.list/orderBy": order_by +"/compute:v1/compute.interconnectLocations.list/pageToken": page_token +"/compute:v1/compute.interconnectLocations.list/project": project +"/compute:v1/compute.interconnects.delete": delete_interconnect +"/compute:v1/compute.interconnects.delete/interconnect": interconnect +"/compute:v1/compute.interconnects.delete/project": project +"/compute:v1/compute.interconnects.delete/requestId": request_id +"/compute:v1/compute.interconnects.get": get_interconnect +"/compute:v1/compute.interconnects.get/interconnect": interconnect +"/compute:v1/compute.interconnects.get/project": project +"/compute:v1/compute.interconnects.insert": insert_interconnect +"/compute:v1/compute.interconnects.insert/project": project +"/compute:v1/compute.interconnects.insert/requestId": request_id +"/compute:v1/compute.interconnects.list": list_interconnects +"/compute:v1/compute.interconnects.list/filter": filter +"/compute:v1/compute.interconnects.list/maxResults": max_results +"/compute:v1/compute.interconnects.list/orderBy": order_by +"/compute:v1/compute.interconnects.list/pageToken": page_token +"/compute:v1/compute.interconnects.list/project": project +"/compute:v1/compute.interconnects.patch": patch_interconnect +"/compute:v1/compute.interconnects.patch/interconnect": interconnect +"/compute:v1/compute.interconnects.patch/project": project +"/compute:v1/compute.interconnects.patch/requestId": request_id "/compute:v1/compute.licenses.get": get_license "/compute:v1/compute.licenses.get/license": license "/compute:v1/compute.licenses.get/project": project @@ -28295,6 +28977,12 @@ "/container:v1beta1/ServerConfig/validMasterVersions/valid_master_version": valid_master_version "/container:v1beta1/ServerConfig/validNodeVersions": valid_node_versions "/container:v1beta1/ServerConfig/validNodeVersions/valid_node_version": valid_node_version +"/container:v1beta1/SetAddonsConfigRequest": set_addons_config_request +"/container:v1beta1/SetAddonsConfigRequest/addonsConfig": addons_config +"/container:v1beta1/SetAddonsConfigRequest/clusterId": cluster_id +"/container:v1beta1/SetAddonsConfigRequest/name": name +"/container:v1beta1/SetAddonsConfigRequest/projectId": project_id +"/container:v1beta1/SetAddonsConfigRequest/zone": zone "/container:v1beta1/SetLabelsRequest": set_labels_request "/container:v1beta1/SetLabelsRequest/clusterId": cluster_id "/container:v1beta1/SetLabelsRequest/labelFingerprint": label_fingerprint @@ -28309,6 +28997,19 @@ "/container:v1beta1/SetLegacyAbacRequest/name": name "/container:v1beta1/SetLegacyAbacRequest/projectId": project_id "/container:v1beta1/SetLegacyAbacRequest/zone": zone +"/container:v1beta1/SetLocationsRequest": set_locations_request +"/container:v1beta1/SetLocationsRequest/clusterId": cluster_id +"/container:v1beta1/SetLocationsRequest/locations": locations +"/container:v1beta1/SetLocationsRequest/locations/location": location +"/container:v1beta1/SetLocationsRequest/name": name +"/container:v1beta1/SetLocationsRequest/projectId": project_id +"/container:v1beta1/SetLocationsRequest/zone": zone +"/container:v1beta1/SetLoggingServiceRequest": set_logging_service_request +"/container:v1beta1/SetLoggingServiceRequest/clusterId": cluster_id +"/container:v1beta1/SetLoggingServiceRequest/loggingService": logging_service +"/container:v1beta1/SetLoggingServiceRequest/name": name +"/container:v1beta1/SetLoggingServiceRequest/projectId": project_id +"/container:v1beta1/SetLoggingServiceRequest/zone": zone "/container:v1beta1/SetMaintenancePolicyRequest": set_maintenance_policy_request "/container:v1beta1/SetMaintenancePolicyRequest/clusterId": cluster_id "/container:v1beta1/SetMaintenancePolicyRequest/maintenancePolicy": maintenance_policy @@ -28322,12 +29023,25 @@ "/container:v1beta1/SetMasterAuthRequest/projectId": project_id "/container:v1beta1/SetMasterAuthRequest/update": update "/container:v1beta1/SetMasterAuthRequest/zone": zone +"/container:v1beta1/SetMonitoringServiceRequest": set_monitoring_service_request +"/container:v1beta1/SetMonitoringServiceRequest/clusterId": cluster_id +"/container:v1beta1/SetMonitoringServiceRequest/monitoringService": monitoring_service +"/container:v1beta1/SetMonitoringServiceRequest/name": name +"/container:v1beta1/SetMonitoringServiceRequest/projectId": project_id +"/container:v1beta1/SetMonitoringServiceRequest/zone": zone "/container:v1beta1/SetNetworkPolicyRequest": set_network_policy_request "/container:v1beta1/SetNetworkPolicyRequest/clusterId": cluster_id "/container:v1beta1/SetNetworkPolicyRequest/name": name "/container:v1beta1/SetNetworkPolicyRequest/networkPolicy": network_policy "/container:v1beta1/SetNetworkPolicyRequest/projectId": project_id "/container:v1beta1/SetNetworkPolicyRequest/zone": zone +"/container:v1beta1/SetNodePoolAutoscalingRequest": set_node_pool_autoscaling_request +"/container:v1beta1/SetNodePoolAutoscalingRequest/autoscaling": autoscaling +"/container:v1beta1/SetNodePoolAutoscalingRequest/clusterId": cluster_id +"/container:v1beta1/SetNodePoolAutoscalingRequest/name": name +"/container:v1beta1/SetNodePoolAutoscalingRequest/nodePoolId": node_pool_id +"/container:v1beta1/SetNodePoolAutoscalingRequest/projectId": project_id +"/container:v1beta1/SetNodePoolAutoscalingRequest/zone": zone "/container:v1beta1/SetNodePoolManagementRequest": set_node_pool_management_request "/container:v1beta1/SetNodePoolManagementRequest/clusterId": cluster_id "/container:v1beta1/SetNodePoolManagementRequest/management": management @@ -28346,6 +29060,20 @@ "/container:v1beta1/UpdateClusterRequest/projectId": project_id "/container:v1beta1/UpdateClusterRequest/update": update "/container:v1beta1/UpdateClusterRequest/zone": zone +"/container:v1beta1/UpdateMasterRequest": update_master_request +"/container:v1beta1/UpdateMasterRequest/clusterId": cluster_id +"/container:v1beta1/UpdateMasterRequest/masterVersion": master_version +"/container:v1beta1/UpdateMasterRequest/name": name +"/container:v1beta1/UpdateMasterRequest/projectId": project_id +"/container:v1beta1/UpdateMasterRequest/zone": zone +"/container:v1beta1/UpdateNodePoolRequest": update_node_pool_request +"/container:v1beta1/UpdateNodePoolRequest/clusterId": cluster_id +"/container:v1beta1/UpdateNodePoolRequest/imageType": image_type +"/container:v1beta1/UpdateNodePoolRequest/name": name +"/container:v1beta1/UpdateNodePoolRequest/nodePoolId": node_pool_id +"/container:v1beta1/UpdateNodePoolRequest/nodeVersion": node_version +"/container:v1beta1/UpdateNodePoolRequest/projectId": project_id +"/container:v1beta1/UpdateNodePoolRequest/zone": zone "/container:v1beta1/container.projects.clusters.list": list_clusters "/container:v1beta1/container.projects.locations.clusters.completeIpRotation": complete_project_location_cluster_ip_rotation "/container:v1beta1/container.projects.locations.clusters.completeIpRotation/name": name @@ -28386,14 +29114,26 @@ "/container:v1beta1/container.projects.locations.clusters.nodePools.list/zone": zone "/container:v1beta1/container.projects.locations.clusters.nodePools.rollback": rollback_project_location_cluster_node_pool "/container:v1beta1/container.projects.locations.clusters.nodePools.rollback/name": name +"/container:v1beta1/container.projects.locations.clusters.nodePools.setAutoscaling": set_project_location_cluster_node_pool_autoscaling +"/container:v1beta1/container.projects.locations.clusters.nodePools.setAutoscaling/name": name "/container:v1beta1/container.projects.locations.clusters.nodePools.setManagement": set_project_location_cluster_node_pool_management "/container:v1beta1/container.projects.locations.clusters.nodePools.setManagement/name": name +"/container:v1beta1/container.projects.locations.clusters.nodePools.update": update_project_location_cluster_node_pool +"/container:v1beta1/container.projects.locations.clusters.nodePools.update/name": name +"/container:v1beta1/container.projects.locations.clusters.setAddons": set_cluster_addons_config +"/container:v1beta1/container.projects.locations.clusters.setAddons/name": name "/container:v1beta1/container.projects.locations.clusters.setLegacyAbac": set_cluster_legacy_abac "/container:v1beta1/container.projects.locations.clusters.setLegacyAbac/name": name +"/container:v1beta1/container.projects.locations.clusters.setLocations": set_cluster_locations +"/container:v1beta1/container.projects.locations.clusters.setLocations/name": name +"/container:v1beta1/container.projects.locations.clusters.setLogging": set_cluster_logging_service +"/container:v1beta1/container.projects.locations.clusters.setLogging/name": name "/container:v1beta1/container.projects.locations.clusters.setMaintenancePolicy": set_project_location_cluster_maintenance_policy "/container:v1beta1/container.projects.locations.clusters.setMaintenancePolicy/name": name "/container:v1beta1/container.projects.locations.clusters.setMasterAuth": set_project_location_cluster_master_auth "/container:v1beta1/container.projects.locations.clusters.setMasterAuth/name": name +"/container:v1beta1/container.projects.locations.clusters.setMonitoring": set_cluster_monitoring_service +"/container:v1beta1/container.projects.locations.clusters.setMonitoring/name": name "/container:v1beta1/container.projects.locations.clusters.setNetworkPolicy": set_project_location_cluster_network_policy "/container:v1beta1/container.projects.locations.clusters.setNetworkPolicy/name": name "/container:v1beta1/container.projects.locations.clusters.setResourceLabels": set_project_location_cluster_resource_labels @@ -28402,6 +29142,8 @@ "/container:v1beta1/container.projects.locations.clusters.startIpRotation/name": name "/container:v1beta1/container.projects.locations.clusters.update": update_project_location_cluster "/container:v1beta1/container.projects.locations.clusters.update/name": name +"/container:v1beta1/container.projects.locations.clusters.updateMaster": update_cluster_master +"/container:v1beta1/container.projects.locations.clusters.updateMaster/name": name "/container:v1beta1/container.projects.locations.getServerConfig": get_project_location_server_config "/container:v1beta1/container.projects.locations.getServerConfig/name": name "/container:v1beta1/container.projects.locations.getServerConfig/projectId": project_id @@ -28418,6 +29160,10 @@ "/container:v1beta1/container.projects.locations.operations.list/projectId": project_id "/container:v1beta1/container.projects.locations.operations.list/zone": zone "/container:v1beta1/container.projects.operations.list": list_operations +"/container:v1beta1/container.projects.zones.clusters.addons": addons_project_zone_cluster +"/container:v1beta1/container.projects.zones.clusters.addons/clusterId": cluster_id +"/container:v1beta1/container.projects.zones.clusters.addons/projectId": project_id +"/container:v1beta1/container.projects.zones.clusters.addons/zone": zone "/container:v1beta1/container.projects.zones.clusters.completeIpRotation": complete_project_zone_cluster_ip_rotation "/container:v1beta1/container.projects.zones.clusters.completeIpRotation/clusterId": cluster_id "/container:v1beta1/container.projects.zones.clusters.completeIpRotation/projectId": project_id @@ -28443,6 +29189,27 @@ "/container:v1beta1/container.projects.zones.clusters.list/parent": parent "/container:v1beta1/container.projects.zones.clusters.list/projectId": project_id "/container:v1beta1/container.projects.zones.clusters.list/zone": zone +"/container:v1beta1/container.projects.zones.clusters.locations": locations_project_zone_cluster +"/container:v1beta1/container.projects.zones.clusters.locations/clusterId": cluster_id +"/container:v1beta1/container.projects.zones.clusters.locations/projectId": project_id +"/container:v1beta1/container.projects.zones.clusters.locations/zone": zone +"/container:v1beta1/container.projects.zones.clusters.logging": logging_project_zone_cluster +"/container:v1beta1/container.projects.zones.clusters.logging/clusterId": cluster_id +"/container:v1beta1/container.projects.zones.clusters.logging/projectId": project_id +"/container:v1beta1/container.projects.zones.clusters.logging/zone": zone +"/container:v1beta1/container.projects.zones.clusters.master": master_project_zone_cluster +"/container:v1beta1/container.projects.zones.clusters.master/clusterId": cluster_id +"/container:v1beta1/container.projects.zones.clusters.master/projectId": project_id +"/container:v1beta1/container.projects.zones.clusters.master/zone": zone +"/container:v1beta1/container.projects.zones.clusters.monitoring": monitoring_project_zone_cluster +"/container:v1beta1/container.projects.zones.clusters.monitoring/clusterId": cluster_id +"/container:v1beta1/container.projects.zones.clusters.monitoring/projectId": project_id +"/container:v1beta1/container.projects.zones.clusters.monitoring/zone": zone +"/container:v1beta1/container.projects.zones.clusters.nodePools.autoscaling": autoscaling_project_zone_cluster_node_pool +"/container:v1beta1/container.projects.zones.clusters.nodePools.autoscaling/clusterId": cluster_id +"/container:v1beta1/container.projects.zones.clusters.nodePools.autoscaling/nodePoolId": node_pool_id +"/container:v1beta1/container.projects.zones.clusters.nodePools.autoscaling/projectId": project_id +"/container:v1beta1/container.projects.zones.clusters.nodePools.autoscaling/zone": zone "/container:v1beta1/container.projects.zones.clusters.nodePools.create": create_project_zone_cluster_node_pool "/container:v1beta1/container.projects.zones.clusters.nodePools.create/clusterId": cluster_id "/container:v1beta1/container.projects.zones.clusters.nodePools.create/projectId": project_id @@ -28474,6 +29241,11 @@ "/container:v1beta1/container.projects.zones.clusters.nodePools.setManagement/nodePoolId": node_pool_id "/container:v1beta1/container.projects.zones.clusters.nodePools.setManagement/projectId": project_id "/container:v1beta1/container.projects.zones.clusters.nodePools.setManagement/zone": zone +"/container:v1beta1/container.projects.zones.clusters.nodePools.update": update_project_zone_cluster_node_pool +"/container:v1beta1/container.projects.zones.clusters.nodePools.update/clusterId": cluster_id +"/container:v1beta1/container.projects.zones.clusters.nodePools.update/nodePoolId": node_pool_id +"/container:v1beta1/container.projects.zones.clusters.nodePools.update/projectId": project_id +"/container:v1beta1/container.projects.zones.clusters.nodePools.update/zone": zone "/container:v1beta1/container.projects.zones.clusters.resourceLabels": resource_project_zone_cluster_labels "/container:v1beta1/container.projects.zones.clusters.resourceLabels/clusterId": cluster_id "/container:v1beta1/container.projects.zones.clusters.resourceLabels/projectId": project_id @@ -28523,6 +29295,7 @@ "/content:v2/Account/adultContent": adult_content "/content:v2/Account/adwordsLinks": adwords_links "/content:v2/Account/adwordsLinks/adwords_link": adwords_link +"/content:v2/Account/googleMyBusinessLink": google_my_business_link "/content:v2/Account/id": id "/content:v2/Account/kind": kind "/content:v2/Account/name": name @@ -28536,6 +29309,9 @@ "/content:v2/AccountAdwordsLink": account_adwords_link "/content:v2/AccountAdwordsLink/adwordsId": adwords_id "/content:v2/AccountAdwordsLink/status": status +"/content:v2/AccountGoogleMyBusinessLink": account_google_my_business_link +"/content:v2/AccountGoogleMyBusinessLink/gmbEmail": gmb_email +"/content:v2/AccountGoogleMyBusinessLink/status": status "/content:v2/AccountIdentifier": account_identifier "/content:v2/AccountIdentifier/aggregatorId": aggregator_id "/content:v2/AccountIdentifier/merchantId": merchant_id @@ -29007,6 +29783,7 @@ "/content:v2/OrderShipment/trackingId": tracking_id "/content:v2/OrderShipmentLineItemShipment": order_shipment_line_item_shipment "/content:v2/OrderShipmentLineItemShipment/lineItemId": line_item_id +"/content:v2/OrderShipmentLineItemShipment/productId": product_id "/content:v2/OrderShipmentLineItemShipment/quantity": quantity "/content:v2/OrdersAcknowledgeRequest": orders_acknowledge_request "/content:v2/OrdersAcknowledgeRequest/operationId": operation_id @@ -29017,8 +29794,11 @@ "/content:v2/OrdersAdvanceTestOrderResponse/kind": kind "/content:v2/OrdersCancelLineItemRequest": orders_cancel_line_item_request "/content:v2/OrdersCancelLineItemRequest/amount": amount +"/content:v2/OrdersCancelLineItemRequest/amountPretax": amount_pretax +"/content:v2/OrdersCancelLineItemRequest/amountTax": amount_tax "/content:v2/OrdersCancelLineItemRequest/lineItemId": line_item_id "/content:v2/OrdersCancelLineItemRequest/operationId": operation_id +"/content:v2/OrdersCancelLineItemRequest/productId": product_id "/content:v2/OrdersCancelLineItemRequest/quantity": quantity "/content:v2/OrdersCancelLineItemRequest/reason": reason "/content:v2/OrdersCancelLineItemRequest/reasonText": reason_text @@ -29059,16 +29839,22 @@ "/content:v2/OrdersCustomBatchRequestEntryCancel/reasonText": reason_text "/content:v2/OrdersCustomBatchRequestEntryCancelLineItem": orders_custom_batch_request_entry_cancel_line_item "/content:v2/OrdersCustomBatchRequestEntryCancelLineItem/amount": amount +"/content:v2/OrdersCustomBatchRequestEntryCancelLineItem/amountPretax": amount_pretax +"/content:v2/OrdersCustomBatchRequestEntryCancelLineItem/amountTax": amount_tax "/content:v2/OrdersCustomBatchRequestEntryCancelLineItem/lineItemId": line_item_id +"/content:v2/OrdersCustomBatchRequestEntryCancelLineItem/productId": product_id "/content:v2/OrdersCustomBatchRequestEntryCancelLineItem/quantity": quantity "/content:v2/OrdersCustomBatchRequestEntryCancelLineItem/reason": reason "/content:v2/OrdersCustomBatchRequestEntryCancelLineItem/reasonText": reason_text "/content:v2/OrdersCustomBatchRequestEntryRefund": orders_custom_batch_request_entry_refund "/content:v2/OrdersCustomBatchRequestEntryRefund/amount": amount +"/content:v2/OrdersCustomBatchRequestEntryRefund/amountPretax": amount_pretax +"/content:v2/OrdersCustomBatchRequestEntryRefund/amountTax": amount_tax "/content:v2/OrdersCustomBatchRequestEntryRefund/reason": reason "/content:v2/OrdersCustomBatchRequestEntryRefund/reasonText": reason_text "/content:v2/OrdersCustomBatchRequestEntryReturnLineItem": orders_custom_batch_request_entry_return_line_item "/content:v2/OrdersCustomBatchRequestEntryReturnLineItem/lineItemId": line_item_id +"/content:v2/OrdersCustomBatchRequestEntryReturnLineItem/productId": product_id "/content:v2/OrdersCustomBatchRequestEntryReturnLineItem/quantity": quantity "/content:v2/OrdersCustomBatchRequestEntryReturnLineItem/reason": reason "/content:v2/OrdersCustomBatchRequestEntryReturnLineItem/reasonText": reason_text @@ -29112,6 +29898,8 @@ "/content:v2/OrdersListResponse/resources/resource": resource "/content:v2/OrdersRefundRequest": orders_refund_request "/content:v2/OrdersRefundRequest/amount": amount +"/content:v2/OrdersRefundRequest/amountPretax": amount_pretax +"/content:v2/OrdersRefundRequest/amountTax": amount_tax "/content:v2/OrdersRefundRequest/operationId": operation_id "/content:v2/OrdersRefundRequest/reason": reason "/content:v2/OrdersRefundRequest/reasonText": reason_text @@ -29121,6 +29909,7 @@ "/content:v2/OrdersReturnLineItemRequest": orders_return_line_item_request "/content:v2/OrdersReturnLineItemRequest/lineItemId": line_item_id "/content:v2/OrdersReturnLineItemRequest/operationId": operation_id +"/content:v2/OrdersReturnLineItemRequest/productId": product_id "/content:v2/OrdersReturnLineItemRequest/quantity": quantity "/content:v2/OrdersReturnLineItemRequest/reason": reason "/content:v2/OrdersReturnLineItemRequest/reasonText": reason_text @@ -29434,6 +30223,7 @@ "/content:v2/TestOrder/kind": kind "/content:v2/TestOrder/lineItems": line_items "/content:v2/TestOrder/lineItems/line_item": line_item +"/content:v2/TestOrder/notificationMode": notification_mode "/content:v2/TestOrder/paymentMethod": payment_method "/content:v2/TestOrder/predefinedDeliveryAddress": predefined_delivery_address "/content:v2/TestOrder/promotions": promotions @@ -29837,6 +30627,7 @@ "/content:v2sandbox/OrderShipment/trackingId": tracking_id "/content:v2sandbox/OrderShipmentLineItemShipment": order_shipment_line_item_shipment "/content:v2sandbox/OrderShipmentLineItemShipment/lineItemId": line_item_id +"/content:v2sandbox/OrderShipmentLineItemShipment/productId": product_id "/content:v2sandbox/OrderShipmentLineItemShipment/quantity": quantity "/content:v2sandbox/OrdersAcknowledgeRequest": orders_acknowledge_request "/content:v2sandbox/OrdersAcknowledgeRequest/operationId": operation_id @@ -29847,8 +30638,11 @@ "/content:v2sandbox/OrdersAdvanceTestOrderResponse/kind": kind "/content:v2sandbox/OrdersCancelLineItemRequest": orders_cancel_line_item_request "/content:v2sandbox/OrdersCancelLineItemRequest/amount": amount +"/content:v2sandbox/OrdersCancelLineItemRequest/amountPretax": amount_pretax +"/content:v2sandbox/OrdersCancelLineItemRequest/amountTax": amount_tax "/content:v2sandbox/OrdersCancelLineItemRequest/lineItemId": line_item_id "/content:v2sandbox/OrdersCancelLineItemRequest/operationId": operation_id +"/content:v2sandbox/OrdersCancelLineItemRequest/productId": product_id "/content:v2sandbox/OrdersCancelLineItemRequest/quantity": quantity "/content:v2sandbox/OrdersCancelLineItemRequest/reason": reason "/content:v2sandbox/OrdersCancelLineItemRequest/reasonText": reason_text @@ -29889,16 +30683,22 @@ "/content:v2sandbox/OrdersCustomBatchRequestEntryCancel/reasonText": reason_text "/content:v2sandbox/OrdersCustomBatchRequestEntryCancelLineItem": orders_custom_batch_request_entry_cancel_line_item "/content:v2sandbox/OrdersCustomBatchRequestEntryCancelLineItem/amount": amount +"/content:v2sandbox/OrdersCustomBatchRequestEntryCancelLineItem/amountPretax": amount_pretax +"/content:v2sandbox/OrdersCustomBatchRequestEntryCancelLineItem/amountTax": amount_tax "/content:v2sandbox/OrdersCustomBatchRequestEntryCancelLineItem/lineItemId": line_item_id +"/content:v2sandbox/OrdersCustomBatchRequestEntryCancelLineItem/productId": product_id "/content:v2sandbox/OrdersCustomBatchRequestEntryCancelLineItem/quantity": quantity "/content:v2sandbox/OrdersCustomBatchRequestEntryCancelLineItem/reason": reason "/content:v2sandbox/OrdersCustomBatchRequestEntryCancelLineItem/reasonText": reason_text "/content:v2sandbox/OrdersCustomBatchRequestEntryRefund": orders_custom_batch_request_entry_refund "/content:v2sandbox/OrdersCustomBatchRequestEntryRefund/amount": amount +"/content:v2sandbox/OrdersCustomBatchRequestEntryRefund/amountPretax": amount_pretax +"/content:v2sandbox/OrdersCustomBatchRequestEntryRefund/amountTax": amount_tax "/content:v2sandbox/OrdersCustomBatchRequestEntryRefund/reason": reason "/content:v2sandbox/OrdersCustomBatchRequestEntryRefund/reasonText": reason_text "/content:v2sandbox/OrdersCustomBatchRequestEntryReturnLineItem": orders_custom_batch_request_entry_return_line_item "/content:v2sandbox/OrdersCustomBatchRequestEntryReturnLineItem/lineItemId": line_item_id +"/content:v2sandbox/OrdersCustomBatchRequestEntryReturnLineItem/productId": product_id "/content:v2sandbox/OrdersCustomBatchRequestEntryReturnLineItem/quantity": quantity "/content:v2sandbox/OrdersCustomBatchRequestEntryReturnLineItem/reason": reason "/content:v2sandbox/OrdersCustomBatchRequestEntryReturnLineItem/reasonText": reason_text @@ -29942,6 +30742,8 @@ "/content:v2sandbox/OrdersListResponse/resources/resource": resource "/content:v2sandbox/OrdersRefundRequest": orders_refund_request "/content:v2sandbox/OrdersRefundRequest/amount": amount +"/content:v2sandbox/OrdersRefundRequest/amountPretax": amount_pretax +"/content:v2sandbox/OrdersRefundRequest/amountTax": amount_tax "/content:v2sandbox/OrdersRefundRequest/operationId": operation_id "/content:v2sandbox/OrdersRefundRequest/reason": reason "/content:v2sandbox/OrdersRefundRequest/reasonText": reason_text @@ -29951,6 +30753,7 @@ "/content:v2sandbox/OrdersReturnLineItemRequest": orders_return_line_item_request "/content:v2sandbox/OrdersReturnLineItemRequest/lineItemId": line_item_id "/content:v2sandbox/OrdersReturnLineItemRequest/operationId": operation_id +"/content:v2sandbox/OrdersReturnLineItemRequest/productId": product_id "/content:v2sandbox/OrdersReturnLineItemRequest/quantity": quantity "/content:v2sandbox/OrdersReturnLineItemRequest/reason": reason "/content:v2sandbox/OrdersReturnLineItemRequest/reasonText": reason_text @@ -29992,6 +30795,7 @@ "/content:v2sandbox/TestOrder/kind": kind "/content:v2sandbox/TestOrder/lineItems": line_items "/content:v2sandbox/TestOrder/lineItems/line_item": line_item +"/content:v2sandbox/TestOrder/notificationMode": notification_mode "/content:v2sandbox/TestOrder/paymentMethod": payment_method "/content:v2sandbox/TestOrder/predefinedDeliveryAddress": predefined_delivery_address "/content:v2sandbox/TestOrder/promotions": promotions @@ -30233,6 +31037,38 @@ "/customsearch:v1/search.cse.list/siteSearchFilter": site_search_filter "/customsearch:v1/search.cse.list/sort": sort "/customsearch:v1/search.cse.list/start": start +"/customsearch:v1/search.cse.siterestrict.list": list_cse_siterestricts +"/customsearch:v1/search.cse.siterestrict.list/c2coff": c2coff +"/customsearch:v1/search.cse.siterestrict.list/cr": cr +"/customsearch:v1/search.cse.siterestrict.list/cx": cx +"/customsearch:v1/search.cse.siterestrict.list/dateRestrict": date_restrict +"/customsearch:v1/search.cse.siterestrict.list/exactTerms": exact_terms +"/customsearch:v1/search.cse.siterestrict.list/excludeTerms": exclude_terms +"/customsearch:v1/search.cse.siterestrict.list/fileType": file_type +"/customsearch:v1/search.cse.siterestrict.list/filter": filter +"/customsearch:v1/search.cse.siterestrict.list/gl": gl +"/customsearch:v1/search.cse.siterestrict.list/googlehost": googlehost +"/customsearch:v1/search.cse.siterestrict.list/highRange": high_range +"/customsearch:v1/search.cse.siterestrict.list/hl": hl +"/customsearch:v1/search.cse.siterestrict.list/hq": hq +"/customsearch:v1/search.cse.siterestrict.list/imgColorType": img_color_type +"/customsearch:v1/search.cse.siterestrict.list/imgDominantColor": img_dominant_color +"/customsearch:v1/search.cse.siterestrict.list/imgSize": img_size +"/customsearch:v1/search.cse.siterestrict.list/imgType": img_type +"/customsearch:v1/search.cse.siterestrict.list/linkSite": link_site +"/customsearch:v1/search.cse.siterestrict.list/lowRange": low_range +"/customsearch:v1/search.cse.siterestrict.list/lr": lr +"/customsearch:v1/search.cse.siterestrict.list/num": num +"/customsearch:v1/search.cse.siterestrict.list/orTerms": or_terms +"/customsearch:v1/search.cse.siterestrict.list/q": q +"/customsearch:v1/search.cse.siterestrict.list/relatedSite": related_site +"/customsearch:v1/search.cse.siterestrict.list/rights": rights +"/customsearch:v1/search.cse.siterestrict.list/safe": safe +"/customsearch:v1/search.cse.siterestrict.list/searchType": search_type +"/customsearch:v1/search.cse.siterestrict.list/siteSearch": site_search +"/customsearch:v1/search.cse.siterestrict.list/siteSearchFilter": site_search_filter +"/customsearch:v1/search.cse.siterestrict.list/sort": sort +"/customsearch:v1/search.cse.siterestrict.list/start": start "/customsearch:v1/userIp": user_ip "/dataflow:v1b3/ApproximateProgress": approximate_progress "/dataflow:v1b3/ApproximateProgress/percentComplete": percent_complete @@ -30289,9 +31125,11 @@ "/dataflow:v1b3/CounterStructuredName": counter_structured_name "/dataflow:v1b3/CounterStructuredName/componentStepName": component_step_name "/dataflow:v1b3/CounterStructuredName/executionStepName": execution_step_name +"/dataflow:v1b3/CounterStructuredName/inputIndex": input_index "/dataflow:v1b3/CounterStructuredName/name": name "/dataflow:v1b3/CounterStructuredName/origin": origin "/dataflow:v1b3/CounterStructuredName/originNamespace": origin_namespace +"/dataflow:v1b3/CounterStructuredName/originalRequestingStepName": original_requesting_step_name "/dataflow:v1b3/CounterStructuredName/originalShuffleStepName": original_shuffle_step_name "/dataflow:v1b3/CounterStructuredName/originalStepName": original_step_name "/dataflow:v1b3/CounterStructuredName/portion": portion @@ -30708,7 +31546,11 @@ "/dataflow:v1b3/SourceMetadata/producesSortedKeys": produces_sorted_keys "/dataflow:v1b3/SourceOperationRequest": source_operation_request "/dataflow:v1b3/SourceOperationRequest/getMetadata": get_metadata +"/dataflow:v1b3/SourceOperationRequest/name": name +"/dataflow:v1b3/SourceOperationRequest/originalName": original_name "/dataflow:v1b3/SourceOperationRequest/split": split +"/dataflow:v1b3/SourceOperationRequest/stageName": stage_name +"/dataflow:v1b3/SourceOperationRequest/systemName": system_name "/dataflow:v1b3/SourceOperationResponse": source_operation_response "/dataflow:v1b3/SourceOperationResponse/getMetadata": get_metadata "/dataflow:v1b3/SourceOperationResponse/split": split @@ -31989,6 +32831,11 @@ "/datastore:v1/ReadOptions/transaction": transaction "/datastore:v1/ReadWrite": read_write "/datastore:v1/ReadWrite/previousTransaction": previous_transaction +"/datastore:v1/ReserveIdsRequest": reserve_ids_request +"/datastore:v1/ReserveIdsRequest/databaseId": database_id +"/datastore:v1/ReserveIdsRequest/keys": keys +"/datastore:v1/ReserveIdsRequest/keys/key": key +"/datastore:v1/ReserveIdsResponse": reserve_ids_response "/datastore:v1/RollbackRequest": rollback_request "/datastore:v1/RollbackRequest/transaction": transaction "/datastore:v1/RollbackResponse": rollback_response @@ -32042,6 +32889,8 @@ "/datastore:v1/datastore.projects.operations.list/name": name "/datastore:v1/datastore.projects.operations.list/pageSize": page_size "/datastore:v1/datastore.projects.operations.list/pageToken": page_token +"/datastore:v1/datastore.projects.reserveIds": reserve_project_ids +"/datastore:v1/datastore.projects.reserveIds/projectId": project_id "/datastore:v1/datastore.projects.rollback": rollback_project "/datastore:v1/datastore.projects.rollback/projectId": project_id "/datastore:v1/datastore.projects.runQuery": run_project_query @@ -32266,6 +33115,11 @@ "/datastore:v1beta3/ReadOptions/transaction": transaction "/datastore:v1beta3/ReadWrite": read_write "/datastore:v1beta3/ReadWrite/previousTransaction": previous_transaction +"/datastore:v1beta3/ReserveIdsRequest": reserve_ids_request +"/datastore:v1beta3/ReserveIdsRequest/databaseId": database_id +"/datastore:v1beta3/ReserveIdsRequest/keys": keys +"/datastore:v1beta3/ReserveIdsRequest/keys/key": key +"/datastore:v1beta3/ReserveIdsResponse": reserve_ids_response "/datastore:v1beta3/RollbackRequest": rollback_request "/datastore:v1beta3/RollbackRequest/transaction": transaction "/datastore:v1beta3/RollbackResponse": rollback_response @@ -32302,6 +33156,8 @@ "/datastore:v1beta3/datastore.projects.commit/projectId": project_id "/datastore:v1beta3/datastore.projects.lookup": lookup_project "/datastore:v1beta3/datastore.projects.lookup/projectId": project_id +"/datastore:v1beta3/datastore.projects.reserveIds": reserve_project_ids +"/datastore:v1beta3/datastore.projects.reserveIds/projectId": project_id "/datastore:v1beta3/datastore.projects.rollback": rollback_project "/datastore:v1beta3/datastore.projects.rollback/projectId": project_id "/datastore:v1beta3/datastore.projects.runQuery": run_project_query @@ -32309,6 +33165,9 @@ "/datastore:v1beta3/fields": fields "/datastore:v1beta3/key": key "/datastore:v1beta3/quotaUser": quota_user +"/deploymentmanager:alpha/AsyncOptions": async_options +"/deploymentmanager:alpha/AsyncOptions/methodMatch": method_match +"/deploymentmanager:alpha/AsyncOptions/pollingOptions": polling_options "/deploymentmanager:alpha/AuditConfig": audit_config "/deploymentmanager:alpha/AuditConfig/auditLogConfigs": audit_log_configs "/deploymentmanager:alpha/AuditConfig/auditLogConfigs/audit_log_config": audit_log_config @@ -32409,6 +33268,9 @@ "/deploymentmanager:alpha/DeploymentsListResponse/nextPageToken": next_page_token "/deploymentmanager:alpha/DeploymentsStopRequest": deployments_stop_request "/deploymentmanager:alpha/DeploymentsStopRequest/fingerprint": fingerprint +"/deploymentmanager:alpha/Diagnostic": diagnostic +"/deploymentmanager:alpha/Diagnostic/field": field +"/deploymentmanager:alpha/Diagnostic/level": level "/deploymentmanager:alpha/Expr": expr "/deploymentmanager:alpha/Expr/description": description "/deploymentmanager:alpha/Expr/expression": expression @@ -32489,6 +33351,8 @@ "/deploymentmanager:alpha/OperationsListResponse/operations": operations "/deploymentmanager:alpha/OperationsListResponse/operations/operation": operation "/deploymentmanager:alpha/Options": options +"/deploymentmanager:alpha/Options/asyncOptions": async_options +"/deploymentmanager:alpha/Options/asyncOptions/async_option": async_option "/deploymentmanager:alpha/Options/inputMappings": input_mappings "/deploymentmanager:alpha/Options/inputMappings/input_mapping": input_mapping "/deploymentmanager:alpha/Options/nameProperty": name_property @@ -32503,6 +33367,13 @@ "/deploymentmanager:alpha/Policy/rules": rules "/deploymentmanager:alpha/Policy/rules/rule": rule "/deploymentmanager:alpha/Policy/version": version +"/deploymentmanager:alpha/PollingOptions": polling_options +"/deploymentmanager:alpha/PollingOptions/diagnostics": diagnostics +"/deploymentmanager:alpha/PollingOptions/diagnostics/diagnostic": diagnostic +"/deploymentmanager:alpha/PollingOptions/failCondition": fail_condition +"/deploymentmanager:alpha/PollingOptions/finishCondition": finish_condition +"/deploymentmanager:alpha/PollingOptions/pollingLink": polling_link +"/deploymentmanager:alpha/PollingOptions/targetLink": target_link "/deploymentmanager:alpha/Resource": resource "/deploymentmanager:alpha/Resource/accessControl": access_control "/deploymentmanager:alpha/Resource/finalProperties": final_properties @@ -32575,6 +33446,7 @@ "/deploymentmanager:alpha/TemplateContents/imports": imports "/deploymentmanager:alpha/TemplateContents/imports/import": import "/deploymentmanager:alpha/TemplateContents/interpreter": interpreter +"/deploymentmanager:alpha/TemplateContents/mainTemplate": main_template "/deploymentmanager:alpha/TemplateContents/schema": schema "/deploymentmanager:alpha/TemplateContents/template": template "/deploymentmanager:alpha/TestPermissionsRequest": test_permissions_request @@ -33352,6 +34224,7 @@ "/deploymentmanager:v2beta/TemplateContents/imports": imports "/deploymentmanager:v2beta/TemplateContents/imports/import": import "/deploymentmanager:v2beta/TemplateContents/interpreter": interpreter +"/deploymentmanager:v2beta/TemplateContents/mainTemplate": main_template "/deploymentmanager:v2beta/TemplateContents/schema": schema "/deploymentmanager:v2beta/TemplateContents/template": template "/deploymentmanager:v2beta/TestPermissionsRequest": test_permissions_request @@ -38750,6 +39623,3025 @@ "/dfareporting:v2.8/key": key "/dfareporting:v2.8/quotaUser": quota_user "/dfareporting:v2.8/userIp": user_ip +"/dfareporting:v3.0/Account": account +"/dfareporting:v3.0/Account/accountPermissionIds": account_permission_ids +"/dfareporting:v3.0/Account/accountPermissionIds/account_permission_id": account_permission_id +"/dfareporting:v3.0/Account/accountProfile": account_profile +"/dfareporting:v3.0/Account/active": active +"/dfareporting:v3.0/Account/activeAdsLimitTier": active_ads_limit_tier +"/dfareporting:v3.0/Account/activeViewOptOut": active_view_opt_out +"/dfareporting:v3.0/Account/availablePermissionIds": available_permission_ids +"/dfareporting:v3.0/Account/availablePermissionIds/available_permission_id": available_permission_id +"/dfareporting:v3.0/Account/countryId": country_id +"/dfareporting:v3.0/Account/currencyId": currency_id +"/dfareporting:v3.0/Account/defaultCreativeSizeId": default_creative_size_id +"/dfareporting:v3.0/Account/description": description +"/dfareporting:v3.0/Account/id": id +"/dfareporting:v3.0/Account/kind": kind +"/dfareporting:v3.0/Account/locale": locale +"/dfareporting:v3.0/Account/maximumImageSize": maximum_image_size +"/dfareporting:v3.0/Account/name": name +"/dfareporting:v3.0/Account/nielsenOcrEnabled": nielsen_ocr_enabled +"/dfareporting:v3.0/Account/reportsConfiguration": reports_configuration +"/dfareporting:v3.0/Account/shareReportsWithTwitter": share_reports_with_twitter +"/dfareporting:v3.0/Account/teaserSizeLimit": teaser_size_limit +"/dfareporting:v3.0/AccountActiveAdSummary": account_active_ad_summary +"/dfareporting:v3.0/AccountActiveAdSummary/accountId": account_id +"/dfareporting:v3.0/AccountActiveAdSummary/activeAds": active_ads +"/dfareporting:v3.0/AccountActiveAdSummary/activeAdsLimitTier": active_ads_limit_tier +"/dfareporting:v3.0/AccountActiveAdSummary/availableAds": available_ads +"/dfareporting:v3.0/AccountActiveAdSummary/kind": kind +"/dfareporting:v3.0/AccountPermission": account_permission +"/dfareporting:v3.0/AccountPermission/accountProfiles": account_profiles +"/dfareporting:v3.0/AccountPermission/accountProfiles/account_profile": account_profile +"/dfareporting:v3.0/AccountPermission/id": id +"/dfareporting:v3.0/AccountPermission/kind": kind +"/dfareporting:v3.0/AccountPermission/level": level +"/dfareporting:v3.0/AccountPermission/name": name +"/dfareporting:v3.0/AccountPermission/permissionGroupId": permission_group_id +"/dfareporting:v3.0/AccountPermissionGroup": account_permission_group +"/dfareporting:v3.0/AccountPermissionGroup/id": id +"/dfareporting:v3.0/AccountPermissionGroup/kind": kind +"/dfareporting:v3.0/AccountPermissionGroup/name": name +"/dfareporting:v3.0/AccountPermissionGroupsListResponse": account_permission_groups_list_response +"/dfareporting:v3.0/AccountPermissionGroupsListResponse/accountPermissionGroups": account_permission_groups +"/dfareporting:v3.0/AccountPermissionGroupsListResponse/accountPermissionGroups/account_permission_group": account_permission_group +"/dfareporting:v3.0/AccountPermissionGroupsListResponse/kind": kind +"/dfareporting:v3.0/AccountPermissionsListResponse": account_permissions_list_response +"/dfareporting:v3.0/AccountPermissionsListResponse/accountPermissions": account_permissions +"/dfareporting:v3.0/AccountPermissionsListResponse/accountPermissions/account_permission": account_permission +"/dfareporting:v3.0/AccountPermissionsListResponse/kind": kind +"/dfareporting:v3.0/AccountUserProfile": account_user_profile +"/dfareporting:v3.0/AccountUserProfile/accountId": account_id +"/dfareporting:v3.0/AccountUserProfile/active": active +"/dfareporting:v3.0/AccountUserProfile/advertiserFilter": advertiser_filter +"/dfareporting:v3.0/AccountUserProfile/campaignFilter": campaign_filter +"/dfareporting:v3.0/AccountUserProfile/comments": comments +"/dfareporting:v3.0/AccountUserProfile/email": email +"/dfareporting:v3.0/AccountUserProfile/id": id +"/dfareporting:v3.0/AccountUserProfile/kind": kind +"/dfareporting:v3.0/AccountUserProfile/locale": locale +"/dfareporting:v3.0/AccountUserProfile/name": name +"/dfareporting:v3.0/AccountUserProfile/siteFilter": site_filter +"/dfareporting:v3.0/AccountUserProfile/subaccountId": subaccount_id +"/dfareporting:v3.0/AccountUserProfile/traffickerType": trafficker_type +"/dfareporting:v3.0/AccountUserProfile/userAccessType": user_access_type +"/dfareporting:v3.0/AccountUserProfile/userRoleFilter": user_role_filter +"/dfareporting:v3.0/AccountUserProfile/userRoleId": user_role_id +"/dfareporting:v3.0/AccountUserProfilesListResponse": account_user_profiles_list_response +"/dfareporting:v3.0/AccountUserProfilesListResponse/accountUserProfiles": account_user_profiles +"/dfareporting:v3.0/AccountUserProfilesListResponse/accountUserProfiles/account_user_profile": account_user_profile +"/dfareporting:v3.0/AccountUserProfilesListResponse/kind": kind +"/dfareporting:v3.0/AccountUserProfilesListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/AccountsListResponse": accounts_list_response +"/dfareporting:v3.0/AccountsListResponse/accounts": accounts +"/dfareporting:v3.0/AccountsListResponse/accounts/account": account +"/dfareporting:v3.0/AccountsListResponse/kind": kind +"/dfareporting:v3.0/AccountsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/Activities": activities +"/dfareporting:v3.0/Activities/filters": filters +"/dfareporting:v3.0/Activities/filters/filter": filter +"/dfareporting:v3.0/Activities/kind": kind +"/dfareporting:v3.0/Activities/metricNames": metric_names +"/dfareporting:v3.0/Activities/metricNames/metric_name": metric_name +"/dfareporting:v3.0/Ad": ad +"/dfareporting:v3.0/Ad/accountId": account_id +"/dfareporting:v3.0/Ad/active": active +"/dfareporting:v3.0/Ad/advertiserId": advertiser_id +"/dfareporting:v3.0/Ad/advertiserIdDimensionValue": advertiser_id_dimension_value +"/dfareporting:v3.0/Ad/archived": archived +"/dfareporting:v3.0/Ad/audienceSegmentId": audience_segment_id +"/dfareporting:v3.0/Ad/campaignId": campaign_id +"/dfareporting:v3.0/Ad/campaignIdDimensionValue": campaign_id_dimension_value +"/dfareporting:v3.0/Ad/clickThroughUrl": click_through_url +"/dfareporting:v3.0/Ad/clickThroughUrlSuffixProperties": click_through_url_suffix_properties +"/dfareporting:v3.0/Ad/comments": comments +"/dfareporting:v3.0/Ad/compatibility": compatibility +"/dfareporting:v3.0/Ad/createInfo": create_info +"/dfareporting:v3.0/Ad/creativeGroupAssignments": creative_group_assignments +"/dfareporting:v3.0/Ad/creativeGroupAssignments/creative_group_assignment": creative_group_assignment +"/dfareporting:v3.0/Ad/creativeRotation": creative_rotation +"/dfareporting:v3.0/Ad/dayPartTargeting": day_part_targeting +"/dfareporting:v3.0/Ad/defaultClickThroughEventTagProperties": default_click_through_event_tag_properties +"/dfareporting:v3.0/Ad/deliverySchedule": delivery_schedule +"/dfareporting:v3.0/Ad/dynamicClickTracker": dynamic_click_tracker +"/dfareporting:v3.0/Ad/endTime": end_time +"/dfareporting:v3.0/Ad/eventTagOverrides": event_tag_overrides +"/dfareporting:v3.0/Ad/eventTagOverrides/event_tag_override": event_tag_override +"/dfareporting:v3.0/Ad/geoTargeting": geo_targeting +"/dfareporting:v3.0/Ad/id": id +"/dfareporting:v3.0/Ad/idDimensionValue": id_dimension_value +"/dfareporting:v3.0/Ad/keyValueTargetingExpression": key_value_targeting_expression +"/dfareporting:v3.0/Ad/kind": kind +"/dfareporting:v3.0/Ad/languageTargeting": language_targeting +"/dfareporting:v3.0/Ad/lastModifiedInfo": last_modified_info +"/dfareporting:v3.0/Ad/name": name +"/dfareporting:v3.0/Ad/placementAssignments": placement_assignments +"/dfareporting:v3.0/Ad/placementAssignments/placement_assignment": placement_assignment +"/dfareporting:v3.0/Ad/remarketingListExpression": remarketing_list_expression +"/dfareporting:v3.0/Ad/size": size +"/dfareporting:v3.0/Ad/sslCompliant": ssl_compliant +"/dfareporting:v3.0/Ad/sslRequired": ssl_required +"/dfareporting:v3.0/Ad/startTime": start_time +"/dfareporting:v3.0/Ad/subaccountId": subaccount_id +"/dfareporting:v3.0/Ad/targetingTemplateId": targeting_template_id +"/dfareporting:v3.0/Ad/technologyTargeting": technology_targeting +"/dfareporting:v3.0/Ad/type": type +"/dfareporting:v3.0/AdBlockingConfiguration": ad_blocking_configuration +"/dfareporting:v3.0/AdBlockingConfiguration/clickThroughUrl": click_through_url +"/dfareporting:v3.0/AdBlockingConfiguration/creativeBundleId": creative_bundle_id +"/dfareporting:v3.0/AdBlockingConfiguration/enabled": enabled +"/dfareporting:v3.0/AdBlockingConfiguration/overrideClickThroughUrl": override_click_through_url +"/dfareporting:v3.0/AdSlot": ad_slot +"/dfareporting:v3.0/AdSlot/comment": comment +"/dfareporting:v3.0/AdSlot/compatibility": compatibility +"/dfareporting:v3.0/AdSlot/height": height +"/dfareporting:v3.0/AdSlot/linkedPlacementId": linked_placement_id +"/dfareporting:v3.0/AdSlot/name": name +"/dfareporting:v3.0/AdSlot/paymentSourceType": payment_source_type +"/dfareporting:v3.0/AdSlot/primary": primary +"/dfareporting:v3.0/AdSlot/width": width +"/dfareporting:v3.0/AdsListResponse": ads_list_response +"/dfareporting:v3.0/AdsListResponse/ads": ads +"/dfareporting:v3.0/AdsListResponse/ads/ad": ad +"/dfareporting:v3.0/AdsListResponse/kind": kind +"/dfareporting:v3.0/AdsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/Advertiser": advertiser +"/dfareporting:v3.0/Advertiser/accountId": account_id +"/dfareporting:v3.0/Advertiser/advertiserGroupId": advertiser_group_id +"/dfareporting:v3.0/Advertiser/clickThroughUrlSuffix": click_through_url_suffix +"/dfareporting:v3.0/Advertiser/defaultClickThroughEventTagId": default_click_through_event_tag_id +"/dfareporting:v3.0/Advertiser/defaultEmail": default_email +"/dfareporting:v3.0/Advertiser/floodlightConfigurationId": floodlight_configuration_id +"/dfareporting:v3.0/Advertiser/floodlightConfigurationIdDimensionValue": floodlight_configuration_id_dimension_value +"/dfareporting:v3.0/Advertiser/id": id +"/dfareporting:v3.0/Advertiser/idDimensionValue": id_dimension_value +"/dfareporting:v3.0/Advertiser/kind": kind +"/dfareporting:v3.0/Advertiser/name": name +"/dfareporting:v3.0/Advertiser/originalFloodlightConfigurationId": original_floodlight_configuration_id +"/dfareporting:v3.0/Advertiser/status": status +"/dfareporting:v3.0/Advertiser/subaccountId": subaccount_id +"/dfareporting:v3.0/Advertiser/suspended": suspended +"/dfareporting:v3.0/AdvertiserGroup": advertiser_group +"/dfareporting:v3.0/AdvertiserGroup/accountId": account_id +"/dfareporting:v3.0/AdvertiserGroup/id": id +"/dfareporting:v3.0/AdvertiserGroup/kind": kind +"/dfareporting:v3.0/AdvertiserGroup/name": name +"/dfareporting:v3.0/AdvertiserGroupsListResponse": advertiser_groups_list_response +"/dfareporting:v3.0/AdvertiserGroupsListResponse/advertiserGroups": advertiser_groups +"/dfareporting:v3.0/AdvertiserGroupsListResponse/advertiserGroups/advertiser_group": advertiser_group +"/dfareporting:v3.0/AdvertiserGroupsListResponse/kind": kind +"/dfareporting:v3.0/AdvertiserGroupsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/AdvertiserLandingPagesListResponse": advertiser_landing_pages_list_response +"/dfareporting:v3.0/AdvertiserLandingPagesListResponse/kind": kind +"/dfareporting:v3.0/AdvertiserLandingPagesListResponse/landingPages": landing_pages +"/dfareporting:v3.0/AdvertiserLandingPagesListResponse/landingPages/landing_page": landing_page +"/dfareporting:v3.0/AdvertiserLandingPagesListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/AdvertisersListResponse": advertisers_list_response +"/dfareporting:v3.0/AdvertisersListResponse/advertisers": advertisers +"/dfareporting:v3.0/AdvertisersListResponse/advertisers/advertiser": advertiser +"/dfareporting:v3.0/AdvertisersListResponse/kind": kind +"/dfareporting:v3.0/AdvertisersListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/AudienceSegment": audience_segment +"/dfareporting:v3.0/AudienceSegment/allocation": allocation +"/dfareporting:v3.0/AudienceSegment/id": id +"/dfareporting:v3.0/AudienceSegment/name": name +"/dfareporting:v3.0/AudienceSegmentGroup": audience_segment_group +"/dfareporting:v3.0/AudienceSegmentGroup/audienceSegments": audience_segments +"/dfareporting:v3.0/AudienceSegmentGroup/audienceSegments/audience_segment": audience_segment +"/dfareporting:v3.0/AudienceSegmentGroup/id": id +"/dfareporting:v3.0/AudienceSegmentGroup/name": name +"/dfareporting:v3.0/Browser": browser +"/dfareporting:v3.0/Browser/browserVersionId": browser_version_id +"/dfareporting:v3.0/Browser/dartId": dart_id +"/dfareporting:v3.0/Browser/kind": kind +"/dfareporting:v3.0/Browser/majorVersion": major_version +"/dfareporting:v3.0/Browser/minorVersion": minor_version +"/dfareporting:v3.0/Browser/name": name +"/dfareporting:v3.0/BrowsersListResponse": browsers_list_response +"/dfareporting:v3.0/BrowsersListResponse/browsers": browsers +"/dfareporting:v3.0/BrowsersListResponse/browsers/browser": browser +"/dfareporting:v3.0/BrowsersListResponse/kind": kind +"/dfareporting:v3.0/Campaign": campaign +"/dfareporting:v3.0/Campaign/accountId": account_id +"/dfareporting:v3.0/Campaign/adBlockingConfiguration": ad_blocking_configuration +"/dfareporting:v3.0/Campaign/additionalCreativeOptimizationConfigurations": additional_creative_optimization_configurations +"/dfareporting:v3.0/Campaign/additionalCreativeOptimizationConfigurations/additional_creative_optimization_configuration": additional_creative_optimization_configuration +"/dfareporting:v3.0/Campaign/advertiserGroupId": advertiser_group_id +"/dfareporting:v3.0/Campaign/advertiserId": advertiser_id +"/dfareporting:v3.0/Campaign/advertiserIdDimensionValue": advertiser_id_dimension_value +"/dfareporting:v3.0/Campaign/archived": archived +"/dfareporting:v3.0/Campaign/audienceSegmentGroups": audience_segment_groups +"/dfareporting:v3.0/Campaign/audienceSegmentGroups/audience_segment_group": audience_segment_group +"/dfareporting:v3.0/Campaign/billingInvoiceCode": billing_invoice_code +"/dfareporting:v3.0/Campaign/clickThroughUrlSuffixProperties": click_through_url_suffix_properties +"/dfareporting:v3.0/Campaign/comment": comment +"/dfareporting:v3.0/Campaign/createInfo": create_info +"/dfareporting:v3.0/Campaign/creativeGroupIds": creative_group_ids +"/dfareporting:v3.0/Campaign/creativeGroupIds/creative_group_id": creative_group_id +"/dfareporting:v3.0/Campaign/creativeOptimizationConfiguration": creative_optimization_configuration +"/dfareporting:v3.0/Campaign/defaultClickThroughEventTagProperties": default_click_through_event_tag_properties +"/dfareporting:v3.0/Campaign/defaultLandingPageId": default_landing_page_id +"/dfareporting:v3.0/Campaign/endDate": end_date +"/dfareporting:v3.0/Campaign/eventTagOverrides": event_tag_overrides +"/dfareporting:v3.0/Campaign/eventTagOverrides/event_tag_override": event_tag_override +"/dfareporting:v3.0/Campaign/externalId": external_id +"/dfareporting:v3.0/Campaign/id": id +"/dfareporting:v3.0/Campaign/idDimensionValue": id_dimension_value +"/dfareporting:v3.0/Campaign/kind": kind +"/dfareporting:v3.0/Campaign/lastModifiedInfo": last_modified_info +"/dfareporting:v3.0/Campaign/lookbackConfiguration": lookback_configuration +"/dfareporting:v3.0/Campaign/name": name +"/dfareporting:v3.0/Campaign/nielsenOcrEnabled": nielsen_ocr_enabled +"/dfareporting:v3.0/Campaign/startDate": start_date +"/dfareporting:v3.0/Campaign/subaccountId": subaccount_id +"/dfareporting:v3.0/Campaign/traffickerEmails": trafficker_emails +"/dfareporting:v3.0/Campaign/traffickerEmails/trafficker_email": trafficker_email +"/dfareporting:v3.0/CampaignCreativeAssociation": campaign_creative_association +"/dfareporting:v3.0/CampaignCreativeAssociation/creativeId": creative_id +"/dfareporting:v3.0/CampaignCreativeAssociation/kind": kind +"/dfareporting:v3.0/CampaignCreativeAssociationsListResponse": campaign_creative_associations_list_response +"/dfareporting:v3.0/CampaignCreativeAssociationsListResponse/campaignCreativeAssociations": campaign_creative_associations +"/dfareporting:v3.0/CampaignCreativeAssociationsListResponse/campaignCreativeAssociations/campaign_creative_association": campaign_creative_association +"/dfareporting:v3.0/CampaignCreativeAssociationsListResponse/kind": kind +"/dfareporting:v3.0/CampaignCreativeAssociationsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/CampaignsListResponse": campaigns_list_response +"/dfareporting:v3.0/CampaignsListResponse/campaigns": campaigns +"/dfareporting:v3.0/CampaignsListResponse/campaigns/campaign": campaign +"/dfareporting:v3.0/CampaignsListResponse/kind": kind +"/dfareporting:v3.0/CampaignsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/ChangeLog": change_log +"/dfareporting:v3.0/ChangeLog/accountId": account_id +"/dfareporting:v3.0/ChangeLog/action": action +"/dfareporting:v3.0/ChangeLog/changeTime": change_time +"/dfareporting:v3.0/ChangeLog/fieldName": field_name +"/dfareporting:v3.0/ChangeLog/id": id +"/dfareporting:v3.0/ChangeLog/kind": kind +"/dfareporting:v3.0/ChangeLog/newValue": new_value +"/dfareporting:v3.0/ChangeLog/objectId": object_id_prop +"/dfareporting:v3.0/ChangeLog/objectType": object_type +"/dfareporting:v3.0/ChangeLog/oldValue": old_value +"/dfareporting:v3.0/ChangeLog/subaccountId": subaccount_id +"/dfareporting:v3.0/ChangeLog/transactionId": transaction_id +"/dfareporting:v3.0/ChangeLog/userProfileId": user_profile_id +"/dfareporting:v3.0/ChangeLog/userProfileName": user_profile_name +"/dfareporting:v3.0/ChangeLogsListResponse": change_logs_list_response +"/dfareporting:v3.0/ChangeLogsListResponse/changeLogs": change_logs +"/dfareporting:v3.0/ChangeLogsListResponse/changeLogs/change_log": change_log +"/dfareporting:v3.0/ChangeLogsListResponse/kind": kind +"/dfareporting:v3.0/ChangeLogsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/CitiesListResponse": cities_list_response +"/dfareporting:v3.0/CitiesListResponse/cities": cities +"/dfareporting:v3.0/CitiesListResponse/cities/city": city +"/dfareporting:v3.0/CitiesListResponse/kind": kind +"/dfareporting:v3.0/City": city +"/dfareporting:v3.0/City/countryCode": country_code +"/dfareporting:v3.0/City/countryDartId": country_dart_id +"/dfareporting:v3.0/City/dartId": dart_id +"/dfareporting:v3.0/City/kind": kind +"/dfareporting:v3.0/City/metroCode": metro_code +"/dfareporting:v3.0/City/metroDmaId": metro_dma_id +"/dfareporting:v3.0/City/name": name +"/dfareporting:v3.0/City/regionCode": region_code +"/dfareporting:v3.0/City/regionDartId": region_dart_id +"/dfareporting:v3.0/ClickTag": click_tag +"/dfareporting:v3.0/ClickTag/clickThroughUrl": click_through_url +"/dfareporting:v3.0/ClickTag/eventName": event_name +"/dfareporting:v3.0/ClickTag/name": name +"/dfareporting:v3.0/ClickThroughUrl": click_through_url +"/dfareporting:v3.0/ClickThroughUrl/computedClickThroughUrl": computed_click_through_url +"/dfareporting:v3.0/ClickThroughUrl/customClickThroughUrl": custom_click_through_url +"/dfareporting:v3.0/ClickThroughUrl/defaultLandingPage": default_landing_page +"/dfareporting:v3.0/ClickThroughUrl/landingPageId": landing_page_id +"/dfareporting:v3.0/ClickThroughUrlSuffixProperties": click_through_url_suffix_properties +"/dfareporting:v3.0/ClickThroughUrlSuffixProperties/clickThroughUrlSuffix": click_through_url_suffix +"/dfareporting:v3.0/ClickThroughUrlSuffixProperties/overrideInheritedSuffix": override_inherited_suffix +"/dfareporting:v3.0/CompanionClickThroughOverride": companion_click_through_override +"/dfareporting:v3.0/CompanionClickThroughOverride/clickThroughUrl": click_through_url +"/dfareporting:v3.0/CompanionClickThroughOverride/creativeId": creative_id +"/dfareporting:v3.0/CompanionSetting": companion_setting +"/dfareporting:v3.0/CompanionSetting/companionsDisabled": companions_disabled +"/dfareporting:v3.0/CompanionSetting/enabledSizes": enabled_sizes +"/dfareporting:v3.0/CompanionSetting/enabledSizes/enabled_size": enabled_size +"/dfareporting:v3.0/CompanionSetting/imageOnly": image_only +"/dfareporting:v3.0/CompanionSetting/kind": kind +"/dfareporting:v3.0/CompatibleFields": compatible_fields +"/dfareporting:v3.0/CompatibleFields/crossDimensionReachReportCompatibleFields": cross_dimension_reach_report_compatible_fields +"/dfareporting:v3.0/CompatibleFields/floodlightReportCompatibleFields": floodlight_report_compatible_fields +"/dfareporting:v3.0/CompatibleFields/kind": kind +"/dfareporting:v3.0/CompatibleFields/pathToConversionReportCompatibleFields": path_to_conversion_report_compatible_fields +"/dfareporting:v3.0/CompatibleFields/reachReportCompatibleFields": reach_report_compatible_fields +"/dfareporting:v3.0/CompatibleFields/reportCompatibleFields": report_compatible_fields +"/dfareporting:v3.0/ConnectionType": connection_type +"/dfareporting:v3.0/ConnectionType/id": id +"/dfareporting:v3.0/ConnectionType/kind": kind +"/dfareporting:v3.0/ConnectionType/name": name +"/dfareporting:v3.0/ConnectionTypesListResponse": connection_types_list_response +"/dfareporting:v3.0/ConnectionTypesListResponse/connectionTypes": connection_types +"/dfareporting:v3.0/ConnectionTypesListResponse/connectionTypes/connection_type": connection_type +"/dfareporting:v3.0/ConnectionTypesListResponse/kind": kind +"/dfareporting:v3.0/ContentCategoriesListResponse": content_categories_list_response +"/dfareporting:v3.0/ContentCategoriesListResponse/contentCategories": content_categories +"/dfareporting:v3.0/ContentCategoriesListResponse/contentCategories/content_category": content_category +"/dfareporting:v3.0/ContentCategoriesListResponse/kind": kind +"/dfareporting:v3.0/ContentCategoriesListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/ContentCategory": content_category +"/dfareporting:v3.0/ContentCategory/accountId": account_id +"/dfareporting:v3.0/ContentCategory/id": id +"/dfareporting:v3.0/ContentCategory/kind": kind +"/dfareporting:v3.0/ContentCategory/name": name +"/dfareporting:v3.0/Conversion": conversion +"/dfareporting:v3.0/Conversion/childDirectedTreatment": child_directed_treatment +"/dfareporting:v3.0/Conversion/customVariables": custom_variables +"/dfareporting:v3.0/Conversion/customVariables/custom_variable": custom_variable +"/dfareporting:v3.0/Conversion/encryptedUserId": encrypted_user_id +"/dfareporting:v3.0/Conversion/encryptedUserIdCandidates": encrypted_user_id_candidates +"/dfareporting:v3.0/Conversion/encryptedUserIdCandidates/encrypted_user_id_candidate": encrypted_user_id_candidate +"/dfareporting:v3.0/Conversion/floodlightActivityId": floodlight_activity_id +"/dfareporting:v3.0/Conversion/floodlightConfigurationId": floodlight_configuration_id +"/dfareporting:v3.0/Conversion/gclid": gclid +"/dfareporting:v3.0/Conversion/kind": kind +"/dfareporting:v3.0/Conversion/limitAdTracking": limit_ad_tracking +"/dfareporting:v3.0/Conversion/mobileDeviceId": mobile_device_id +"/dfareporting:v3.0/Conversion/ordinal": ordinal +"/dfareporting:v3.0/Conversion/quantity": quantity +"/dfareporting:v3.0/Conversion/timestampMicros": timestamp_micros +"/dfareporting:v3.0/Conversion/value": value +"/dfareporting:v3.0/ConversionError": conversion_error +"/dfareporting:v3.0/ConversionError/code": code +"/dfareporting:v3.0/ConversionError/kind": kind +"/dfareporting:v3.0/ConversionError/message": message +"/dfareporting:v3.0/ConversionStatus": conversion_status +"/dfareporting:v3.0/ConversionStatus/conversion": conversion +"/dfareporting:v3.0/ConversionStatus/errors": errors +"/dfareporting:v3.0/ConversionStatus/errors/error": error +"/dfareporting:v3.0/ConversionStatus/kind": kind +"/dfareporting:v3.0/ConversionsBatchInsertRequest": conversions_batch_insert_request +"/dfareporting:v3.0/ConversionsBatchInsertRequest/conversions": conversions +"/dfareporting:v3.0/ConversionsBatchInsertRequest/conversions/conversion": conversion +"/dfareporting:v3.0/ConversionsBatchInsertRequest/encryptionInfo": encryption_info +"/dfareporting:v3.0/ConversionsBatchInsertRequest/kind": kind +"/dfareporting:v3.0/ConversionsBatchInsertResponse": conversions_batch_insert_response +"/dfareporting:v3.0/ConversionsBatchInsertResponse/hasFailures": has_failures +"/dfareporting:v3.0/ConversionsBatchInsertResponse/kind": kind +"/dfareporting:v3.0/ConversionsBatchInsertResponse/status": status +"/dfareporting:v3.0/ConversionsBatchInsertResponse/status/status": status +"/dfareporting:v3.0/ConversionsBatchUpdateRequest": conversions_batch_update_request +"/dfareporting:v3.0/ConversionsBatchUpdateRequest/conversions": conversions +"/dfareporting:v3.0/ConversionsBatchUpdateRequest/conversions/conversion": conversion +"/dfareporting:v3.0/ConversionsBatchUpdateRequest/encryptionInfo": encryption_info +"/dfareporting:v3.0/ConversionsBatchUpdateRequest/kind": kind +"/dfareporting:v3.0/ConversionsBatchUpdateResponse": conversions_batch_update_response +"/dfareporting:v3.0/ConversionsBatchUpdateResponse/hasFailures": has_failures +"/dfareporting:v3.0/ConversionsBatchUpdateResponse/kind": kind +"/dfareporting:v3.0/ConversionsBatchUpdateResponse/status": status +"/dfareporting:v3.0/ConversionsBatchUpdateResponse/status/status": status +"/dfareporting:v3.0/CountriesListResponse": countries_list_response +"/dfareporting:v3.0/CountriesListResponse/countries": countries +"/dfareporting:v3.0/CountriesListResponse/countries/country": country +"/dfareporting:v3.0/CountriesListResponse/kind": kind +"/dfareporting:v3.0/Country": country +"/dfareporting:v3.0/Country/countryCode": country_code +"/dfareporting:v3.0/Country/dartId": dart_id +"/dfareporting:v3.0/Country/kind": kind +"/dfareporting:v3.0/Country/name": name +"/dfareporting:v3.0/Country/sslEnabled": ssl_enabled +"/dfareporting:v3.0/Creative": creative +"/dfareporting:v3.0/Creative/accountId": account_id +"/dfareporting:v3.0/Creative/active": active +"/dfareporting:v3.0/Creative/adParameters": ad_parameters +"/dfareporting:v3.0/Creative/adTagKeys": ad_tag_keys +"/dfareporting:v3.0/Creative/adTagKeys/ad_tag_key": ad_tag_key +"/dfareporting:v3.0/Creative/advertiserId": advertiser_id +"/dfareporting:v3.0/Creative/allowScriptAccess": allow_script_access +"/dfareporting:v3.0/Creative/archived": archived +"/dfareporting:v3.0/Creative/artworkType": artwork_type +"/dfareporting:v3.0/Creative/authoringSource": authoring_source +"/dfareporting:v3.0/Creative/authoringTool": authoring_tool +"/dfareporting:v3.0/Creative/autoAdvanceImages": auto_advance_images +"/dfareporting:v3.0/Creative/backgroundColor": background_color +"/dfareporting:v3.0/Creative/backupImageClickThroughUrl": backup_image_click_through_url +"/dfareporting:v3.0/Creative/backupImageFeatures": backup_image_features +"/dfareporting:v3.0/Creative/backupImageFeatures/backup_image_feature": backup_image_feature +"/dfareporting:v3.0/Creative/backupImageReportingLabel": backup_image_reporting_label +"/dfareporting:v3.0/Creative/backupImageTargetWindow": backup_image_target_window +"/dfareporting:v3.0/Creative/clickTags": click_tags +"/dfareporting:v3.0/Creative/clickTags/click_tag": click_tag +"/dfareporting:v3.0/Creative/commercialId": commercial_id +"/dfareporting:v3.0/Creative/companionCreatives": companion_creatives +"/dfareporting:v3.0/Creative/companionCreatives/companion_creative": companion_creative +"/dfareporting:v3.0/Creative/compatibility": compatibility +"/dfareporting:v3.0/Creative/compatibility/compatibility": compatibility +"/dfareporting:v3.0/Creative/convertFlashToHtml5": convert_flash_to_html5 +"/dfareporting:v3.0/Creative/counterCustomEvents": counter_custom_events +"/dfareporting:v3.0/Creative/counterCustomEvents/counter_custom_event": counter_custom_event +"/dfareporting:v3.0/Creative/creativeAssetSelection": creative_asset_selection +"/dfareporting:v3.0/Creative/creativeAssets": creative_assets +"/dfareporting:v3.0/Creative/creativeAssets/creative_asset": creative_asset +"/dfareporting:v3.0/Creative/creativeFieldAssignments": creative_field_assignments +"/dfareporting:v3.0/Creative/creativeFieldAssignments/creative_field_assignment": creative_field_assignment +"/dfareporting:v3.0/Creative/customKeyValues": custom_key_values +"/dfareporting:v3.0/Creative/customKeyValues/custom_key_value": custom_key_value +"/dfareporting:v3.0/Creative/dynamicAssetSelection": dynamic_asset_selection +"/dfareporting:v3.0/Creative/exitCustomEvents": exit_custom_events +"/dfareporting:v3.0/Creative/exitCustomEvents/exit_custom_event": exit_custom_event +"/dfareporting:v3.0/Creative/fsCommand": fs_command +"/dfareporting:v3.0/Creative/htmlCode": html_code +"/dfareporting:v3.0/Creative/htmlCodeLocked": html_code_locked +"/dfareporting:v3.0/Creative/id": id +"/dfareporting:v3.0/Creative/idDimensionValue": id_dimension_value +"/dfareporting:v3.0/Creative/kind": kind +"/dfareporting:v3.0/Creative/lastModifiedInfo": last_modified_info +"/dfareporting:v3.0/Creative/latestTraffickedCreativeId": latest_trafficked_creative_id +"/dfareporting:v3.0/Creative/name": name +"/dfareporting:v3.0/Creative/overrideCss": override_css +"/dfareporting:v3.0/Creative/politeLoadAssetId": polite_load_asset_id +"/dfareporting:v3.0/Creative/progressOffset": progress_offset +"/dfareporting:v3.0/Creative/redirectUrl": redirect_url +"/dfareporting:v3.0/Creative/renderingId": rendering_id +"/dfareporting:v3.0/Creative/renderingIdDimensionValue": rendering_id_dimension_value +"/dfareporting:v3.0/Creative/requiredFlashPluginVersion": required_flash_plugin_version +"/dfareporting:v3.0/Creative/requiredFlashVersion": required_flash_version +"/dfareporting:v3.0/Creative/size": size +"/dfareporting:v3.0/Creative/skipOffset": skip_offset +"/dfareporting:v3.0/Creative/skippable": skippable +"/dfareporting:v3.0/Creative/sslCompliant": ssl_compliant +"/dfareporting:v3.0/Creative/sslOverride": ssl_override +"/dfareporting:v3.0/Creative/studioAdvertiserId": studio_advertiser_id +"/dfareporting:v3.0/Creative/studioCreativeId": studio_creative_id +"/dfareporting:v3.0/Creative/studioTraffickedCreativeId": studio_trafficked_creative_id +"/dfareporting:v3.0/Creative/subaccountId": subaccount_id +"/dfareporting:v3.0/Creative/thirdPartyBackupImageImpressionsUrl": third_party_backup_image_impressions_url +"/dfareporting:v3.0/Creative/thirdPartyRichMediaImpressionsUrl": third_party_rich_media_impressions_url +"/dfareporting:v3.0/Creative/thirdPartyUrls": third_party_urls +"/dfareporting:v3.0/Creative/thirdPartyUrls/third_party_url": third_party_url +"/dfareporting:v3.0/Creative/timerCustomEvents": timer_custom_events +"/dfareporting:v3.0/Creative/timerCustomEvents/timer_custom_event": timer_custom_event +"/dfareporting:v3.0/Creative/totalFileSize": total_file_size +"/dfareporting:v3.0/Creative/type": type +"/dfareporting:v3.0/Creative/universalAdId": universal_ad_id +"/dfareporting:v3.0/Creative/version": version +"/dfareporting:v3.0/Creative/videoDescription": video_description +"/dfareporting:v3.0/Creative/videoDuration": video_duration +"/dfareporting:v3.0/CreativeAsset": creative_asset +"/dfareporting:v3.0/CreativeAsset/actionScript3": action_script3 +"/dfareporting:v3.0/CreativeAsset/active": active +"/dfareporting:v3.0/CreativeAsset/alignment": alignment +"/dfareporting:v3.0/CreativeAsset/artworkType": artwork_type +"/dfareporting:v3.0/CreativeAsset/assetIdentifier": asset_identifier +"/dfareporting:v3.0/CreativeAsset/backupImageExit": backup_image_exit +"/dfareporting:v3.0/CreativeAsset/bitRate": bit_rate +"/dfareporting:v3.0/CreativeAsset/childAssetType": child_asset_type +"/dfareporting:v3.0/CreativeAsset/collapsedSize": collapsed_size +"/dfareporting:v3.0/CreativeAsset/companionCreativeIds": companion_creative_ids +"/dfareporting:v3.0/CreativeAsset/companionCreativeIds/companion_creative_id": companion_creative_id +"/dfareporting:v3.0/CreativeAsset/customStartTimeValue": custom_start_time_value +"/dfareporting:v3.0/CreativeAsset/detectedFeatures": detected_features +"/dfareporting:v3.0/CreativeAsset/detectedFeatures/detected_feature": detected_feature +"/dfareporting:v3.0/CreativeAsset/displayType": display_type +"/dfareporting:v3.0/CreativeAsset/duration": duration +"/dfareporting:v3.0/CreativeAsset/durationType": duration_type +"/dfareporting:v3.0/CreativeAsset/expandedDimension": expanded_dimension +"/dfareporting:v3.0/CreativeAsset/fileSize": file_size +"/dfareporting:v3.0/CreativeAsset/flashVersion": flash_version +"/dfareporting:v3.0/CreativeAsset/hideFlashObjects": hide_flash_objects +"/dfareporting:v3.0/CreativeAsset/hideSelectionBoxes": hide_selection_boxes +"/dfareporting:v3.0/CreativeAsset/horizontallyLocked": horizontally_locked +"/dfareporting:v3.0/CreativeAsset/id": id +"/dfareporting:v3.0/CreativeAsset/idDimensionValue": id_dimension_value +"/dfareporting:v3.0/CreativeAsset/mimeType": mime_type +"/dfareporting:v3.0/CreativeAsset/offset": offset +"/dfareporting:v3.0/CreativeAsset/orientation": orientation +"/dfareporting:v3.0/CreativeAsset/originalBackup": original_backup +"/dfareporting:v3.0/CreativeAsset/position": position +"/dfareporting:v3.0/CreativeAsset/positionLeftUnit": position_left_unit +"/dfareporting:v3.0/CreativeAsset/positionTopUnit": position_top_unit +"/dfareporting:v3.0/CreativeAsset/progressiveServingUrl": progressive_serving_url +"/dfareporting:v3.0/CreativeAsset/pushdown": pushdown +"/dfareporting:v3.0/CreativeAsset/pushdownDuration": pushdown_duration +"/dfareporting:v3.0/CreativeAsset/role": role +"/dfareporting:v3.0/CreativeAsset/size": size +"/dfareporting:v3.0/CreativeAsset/sslCompliant": ssl_compliant +"/dfareporting:v3.0/CreativeAsset/startTimeType": start_time_type +"/dfareporting:v3.0/CreativeAsset/streamingServingUrl": streaming_serving_url +"/dfareporting:v3.0/CreativeAsset/transparency": transparency +"/dfareporting:v3.0/CreativeAsset/verticallyLocked": vertically_locked +"/dfareporting:v3.0/CreativeAsset/videoDuration": video_duration +"/dfareporting:v3.0/CreativeAsset/windowMode": window_mode +"/dfareporting:v3.0/CreativeAsset/zIndex": z_index +"/dfareporting:v3.0/CreativeAsset/zipFilename": zip_filename +"/dfareporting:v3.0/CreativeAsset/zipFilesize": zip_filesize +"/dfareporting:v3.0/CreativeAssetId": creative_asset_id +"/dfareporting:v3.0/CreativeAssetId/name": name +"/dfareporting:v3.0/CreativeAssetId/type": type +"/dfareporting:v3.0/CreativeAssetMetadata": creative_asset_metadata +"/dfareporting:v3.0/CreativeAssetMetadata/assetIdentifier": asset_identifier +"/dfareporting:v3.0/CreativeAssetMetadata/clickTags": click_tags +"/dfareporting:v3.0/CreativeAssetMetadata/clickTags/click_tag": click_tag +"/dfareporting:v3.0/CreativeAssetMetadata/detectedFeatures": detected_features +"/dfareporting:v3.0/CreativeAssetMetadata/detectedFeatures/detected_feature": detected_feature +"/dfareporting:v3.0/CreativeAssetMetadata/id": id +"/dfareporting:v3.0/CreativeAssetMetadata/idDimensionValue": id_dimension_value +"/dfareporting:v3.0/CreativeAssetMetadata/kind": kind +"/dfareporting:v3.0/CreativeAssetMetadata/warnedValidationRules": warned_validation_rules +"/dfareporting:v3.0/CreativeAssetMetadata/warnedValidationRules/warned_validation_rule": warned_validation_rule +"/dfareporting:v3.0/CreativeAssetSelection": creative_asset_selection +"/dfareporting:v3.0/CreativeAssetSelection/defaultAssetId": default_asset_id +"/dfareporting:v3.0/CreativeAssetSelection/rules": rules +"/dfareporting:v3.0/CreativeAssetSelection/rules/rule": rule +"/dfareporting:v3.0/CreativeAssignment": creative_assignment +"/dfareporting:v3.0/CreativeAssignment/active": active +"/dfareporting:v3.0/CreativeAssignment/applyEventTags": apply_event_tags +"/dfareporting:v3.0/CreativeAssignment/clickThroughUrl": click_through_url +"/dfareporting:v3.0/CreativeAssignment/companionCreativeOverrides": companion_creative_overrides +"/dfareporting:v3.0/CreativeAssignment/companionCreativeOverrides/companion_creative_override": companion_creative_override +"/dfareporting:v3.0/CreativeAssignment/creativeGroupAssignments": creative_group_assignments +"/dfareporting:v3.0/CreativeAssignment/creativeGroupAssignments/creative_group_assignment": creative_group_assignment +"/dfareporting:v3.0/CreativeAssignment/creativeId": creative_id +"/dfareporting:v3.0/CreativeAssignment/creativeIdDimensionValue": creative_id_dimension_value +"/dfareporting:v3.0/CreativeAssignment/endTime": end_time +"/dfareporting:v3.0/CreativeAssignment/richMediaExitOverrides": rich_media_exit_overrides +"/dfareporting:v3.0/CreativeAssignment/richMediaExitOverrides/rich_media_exit_override": rich_media_exit_override +"/dfareporting:v3.0/CreativeAssignment/sequence": sequence +"/dfareporting:v3.0/CreativeAssignment/sslCompliant": ssl_compliant +"/dfareporting:v3.0/CreativeAssignment/startTime": start_time +"/dfareporting:v3.0/CreativeAssignment/weight": weight +"/dfareporting:v3.0/CreativeClickThroughUrl": creative_click_through_url +"/dfareporting:v3.0/CreativeClickThroughUrl/computedClickThroughUrl": computed_click_through_url +"/dfareporting:v3.0/CreativeClickThroughUrl/customClickThroughUrl": custom_click_through_url +"/dfareporting:v3.0/CreativeClickThroughUrl/landingPageId": landing_page_id +"/dfareporting:v3.0/CreativeCustomEvent": creative_custom_event +"/dfareporting:v3.0/CreativeCustomEvent/advertiserCustomEventId": advertiser_custom_event_id +"/dfareporting:v3.0/CreativeCustomEvent/advertiserCustomEventName": advertiser_custom_event_name +"/dfareporting:v3.0/CreativeCustomEvent/advertiserCustomEventType": advertiser_custom_event_type +"/dfareporting:v3.0/CreativeCustomEvent/artworkLabel": artwork_label +"/dfareporting:v3.0/CreativeCustomEvent/artworkType": artwork_type +"/dfareporting:v3.0/CreativeCustomEvent/exitClickThroughUrl": exit_click_through_url +"/dfareporting:v3.0/CreativeCustomEvent/id": id +"/dfareporting:v3.0/CreativeCustomEvent/popupWindowProperties": popup_window_properties +"/dfareporting:v3.0/CreativeCustomEvent/targetType": target_type +"/dfareporting:v3.0/CreativeCustomEvent/videoReportingId": video_reporting_id +"/dfareporting:v3.0/CreativeField": creative_field +"/dfareporting:v3.0/CreativeField/accountId": account_id +"/dfareporting:v3.0/CreativeField/advertiserId": advertiser_id +"/dfareporting:v3.0/CreativeField/advertiserIdDimensionValue": advertiser_id_dimension_value +"/dfareporting:v3.0/CreativeField/id": id +"/dfareporting:v3.0/CreativeField/kind": kind +"/dfareporting:v3.0/CreativeField/name": name +"/dfareporting:v3.0/CreativeField/subaccountId": subaccount_id +"/dfareporting:v3.0/CreativeFieldAssignment": creative_field_assignment +"/dfareporting:v3.0/CreativeFieldAssignment/creativeFieldId": creative_field_id +"/dfareporting:v3.0/CreativeFieldAssignment/creativeFieldValueId": creative_field_value_id +"/dfareporting:v3.0/CreativeFieldValue": creative_field_value +"/dfareporting:v3.0/CreativeFieldValue/id": id +"/dfareporting:v3.0/CreativeFieldValue/kind": kind +"/dfareporting:v3.0/CreativeFieldValue/value": value +"/dfareporting:v3.0/CreativeFieldValuesListResponse": creative_field_values_list_response +"/dfareporting:v3.0/CreativeFieldValuesListResponse/creativeFieldValues": creative_field_values +"/dfareporting:v3.0/CreativeFieldValuesListResponse/creativeFieldValues/creative_field_value": creative_field_value +"/dfareporting:v3.0/CreativeFieldValuesListResponse/kind": kind +"/dfareporting:v3.0/CreativeFieldValuesListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/CreativeFieldsListResponse": creative_fields_list_response +"/dfareporting:v3.0/CreativeFieldsListResponse/creativeFields": creative_fields +"/dfareporting:v3.0/CreativeFieldsListResponse/creativeFields/creative_field": creative_field +"/dfareporting:v3.0/CreativeFieldsListResponse/kind": kind +"/dfareporting:v3.0/CreativeFieldsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/CreativeGroup": creative_group +"/dfareporting:v3.0/CreativeGroup/accountId": account_id +"/dfareporting:v3.0/CreativeGroup/advertiserId": advertiser_id +"/dfareporting:v3.0/CreativeGroup/advertiserIdDimensionValue": advertiser_id_dimension_value +"/dfareporting:v3.0/CreativeGroup/groupNumber": group_number +"/dfareporting:v3.0/CreativeGroup/id": id +"/dfareporting:v3.0/CreativeGroup/kind": kind +"/dfareporting:v3.0/CreativeGroup/name": name +"/dfareporting:v3.0/CreativeGroup/subaccountId": subaccount_id +"/dfareporting:v3.0/CreativeGroupAssignment": creative_group_assignment +"/dfareporting:v3.0/CreativeGroupAssignment/creativeGroupId": creative_group_id +"/dfareporting:v3.0/CreativeGroupAssignment/creativeGroupNumber": creative_group_number +"/dfareporting:v3.0/CreativeGroupsListResponse": creative_groups_list_response +"/dfareporting:v3.0/CreativeGroupsListResponse/creativeGroups": creative_groups +"/dfareporting:v3.0/CreativeGroupsListResponse/creativeGroups/creative_group": creative_group +"/dfareporting:v3.0/CreativeGroupsListResponse/kind": kind +"/dfareporting:v3.0/CreativeGroupsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/CreativeOptimizationConfiguration": creative_optimization_configuration +"/dfareporting:v3.0/CreativeOptimizationConfiguration/id": id +"/dfareporting:v3.0/CreativeOptimizationConfiguration/name": name +"/dfareporting:v3.0/CreativeOptimizationConfiguration/optimizationActivitys": optimization_activitys +"/dfareporting:v3.0/CreativeOptimizationConfiguration/optimizationActivitys/optimization_activity": optimization_activity +"/dfareporting:v3.0/CreativeOptimizationConfiguration/optimizationModel": optimization_model +"/dfareporting:v3.0/CreativeRotation": creative_rotation +"/dfareporting:v3.0/CreativeRotation/creativeAssignments": creative_assignments +"/dfareporting:v3.0/CreativeRotation/creativeAssignments/creative_assignment": creative_assignment +"/dfareporting:v3.0/CreativeRotation/creativeOptimizationConfigurationId": creative_optimization_configuration_id +"/dfareporting:v3.0/CreativeRotation/type": type +"/dfareporting:v3.0/CreativeRotation/weightCalculationStrategy": weight_calculation_strategy +"/dfareporting:v3.0/CreativeSettings": creative_settings +"/dfareporting:v3.0/CreativeSettings/iFrameFooter": i_frame_footer +"/dfareporting:v3.0/CreativeSettings/iFrameHeader": i_frame_header +"/dfareporting:v3.0/CreativesListResponse": creatives_list_response +"/dfareporting:v3.0/CreativesListResponse/creatives": creatives +"/dfareporting:v3.0/CreativesListResponse/creatives/creative": creative +"/dfareporting:v3.0/CreativesListResponse/kind": kind +"/dfareporting:v3.0/CreativesListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/CrossDimensionReachReportCompatibleFields": cross_dimension_reach_report_compatible_fields +"/dfareporting:v3.0/CrossDimensionReachReportCompatibleFields/breakdown": breakdown +"/dfareporting:v3.0/CrossDimensionReachReportCompatibleFields/breakdown/breakdown": breakdown +"/dfareporting:v3.0/CrossDimensionReachReportCompatibleFields/dimensionFilters": dimension_filters +"/dfareporting:v3.0/CrossDimensionReachReportCompatibleFields/dimensionFilters/dimension_filter": dimension_filter +"/dfareporting:v3.0/CrossDimensionReachReportCompatibleFields/kind": kind +"/dfareporting:v3.0/CrossDimensionReachReportCompatibleFields/metrics": metrics +"/dfareporting:v3.0/CrossDimensionReachReportCompatibleFields/metrics/metric": metric +"/dfareporting:v3.0/CrossDimensionReachReportCompatibleFields/overlapMetrics": overlap_metrics +"/dfareporting:v3.0/CrossDimensionReachReportCompatibleFields/overlapMetrics/overlap_metric": overlap_metric +"/dfareporting:v3.0/CustomFloodlightVariable": custom_floodlight_variable +"/dfareporting:v3.0/CustomFloodlightVariable/kind": kind +"/dfareporting:v3.0/CustomFloodlightVariable/type": type +"/dfareporting:v3.0/CustomFloodlightVariable/value": value +"/dfareporting:v3.0/CustomRichMediaEvents": custom_rich_media_events +"/dfareporting:v3.0/CustomRichMediaEvents/filteredEventIds": filtered_event_ids +"/dfareporting:v3.0/CustomRichMediaEvents/filteredEventIds/filtered_event_id": filtered_event_id +"/dfareporting:v3.0/CustomRichMediaEvents/kind": kind +"/dfareporting:v3.0/DateRange": date_range +"/dfareporting:v3.0/DateRange/endDate": end_date +"/dfareporting:v3.0/DateRange/kind": kind +"/dfareporting:v3.0/DateRange/relativeDateRange": relative_date_range +"/dfareporting:v3.0/DateRange/startDate": start_date +"/dfareporting:v3.0/DayPartTargeting": day_part_targeting +"/dfareporting:v3.0/DayPartTargeting/daysOfWeek": days_of_week +"/dfareporting:v3.0/DayPartTargeting/daysOfWeek/days_of_week": days_of_week +"/dfareporting:v3.0/DayPartTargeting/hoursOfDay": hours_of_day +"/dfareporting:v3.0/DayPartTargeting/hoursOfDay/hours_of_day": hours_of_day +"/dfareporting:v3.0/DayPartTargeting/userLocalTime": user_local_time +"/dfareporting:v3.0/DefaultClickThroughEventTagProperties": default_click_through_event_tag_properties +"/dfareporting:v3.0/DefaultClickThroughEventTagProperties/defaultClickThroughEventTagId": default_click_through_event_tag_id +"/dfareporting:v3.0/DefaultClickThroughEventTagProperties/overrideInheritedEventTag": override_inherited_event_tag +"/dfareporting:v3.0/DeliverySchedule": delivery_schedule +"/dfareporting:v3.0/DeliverySchedule/frequencyCap": frequency_cap +"/dfareporting:v3.0/DeliverySchedule/hardCutoff": hard_cutoff +"/dfareporting:v3.0/DeliverySchedule/impressionRatio": impression_ratio +"/dfareporting:v3.0/DeliverySchedule/priority": priority +"/dfareporting:v3.0/DfpSettings": dfp_settings +"/dfareporting:v3.0/DfpSettings/dfpNetworkCode": dfp_network_code +"/dfareporting:v3.0/DfpSettings/dfpNetworkName": dfp_network_name +"/dfareporting:v3.0/DfpSettings/programmaticPlacementAccepted": programmatic_placement_accepted +"/dfareporting:v3.0/DfpSettings/pubPaidPlacementAccepted": pub_paid_placement_accepted +"/dfareporting:v3.0/DfpSettings/publisherPortalOnly": publisher_portal_only +"/dfareporting:v3.0/Dimension": dimension +"/dfareporting:v3.0/Dimension/kind": kind +"/dfareporting:v3.0/Dimension/name": name +"/dfareporting:v3.0/DimensionFilter": dimension_filter +"/dfareporting:v3.0/DimensionFilter/dimensionName": dimension_name +"/dfareporting:v3.0/DimensionFilter/kind": kind +"/dfareporting:v3.0/DimensionFilter/value": value +"/dfareporting:v3.0/DimensionValue": dimension_value +"/dfareporting:v3.0/DimensionValue/dimensionName": dimension_name +"/dfareporting:v3.0/DimensionValue/etag": etag +"/dfareporting:v3.0/DimensionValue/id": id +"/dfareporting:v3.0/DimensionValue/kind": kind +"/dfareporting:v3.0/DimensionValue/matchType": match_type +"/dfareporting:v3.0/DimensionValue/value": value +"/dfareporting:v3.0/DimensionValueList": dimension_value_list +"/dfareporting:v3.0/DimensionValueList/etag": etag +"/dfareporting:v3.0/DimensionValueList/items": items +"/dfareporting:v3.0/DimensionValueList/items/item": item +"/dfareporting:v3.0/DimensionValueList/kind": kind +"/dfareporting:v3.0/DimensionValueList/nextPageToken": next_page_token +"/dfareporting:v3.0/DimensionValueRequest": dimension_value_request +"/dfareporting:v3.0/DimensionValueRequest/dimensionName": dimension_name +"/dfareporting:v3.0/DimensionValueRequest/endDate": end_date +"/dfareporting:v3.0/DimensionValueRequest/filters": filters +"/dfareporting:v3.0/DimensionValueRequest/filters/filter": filter +"/dfareporting:v3.0/DimensionValueRequest/kind": kind +"/dfareporting:v3.0/DimensionValueRequest/startDate": start_date +"/dfareporting:v3.0/DirectorySite": directory_site +"/dfareporting:v3.0/DirectorySite/active": active +"/dfareporting:v3.0/DirectorySite/contactAssignments": contact_assignments +"/dfareporting:v3.0/DirectorySite/contactAssignments/contact_assignment": contact_assignment +"/dfareporting:v3.0/DirectorySite/countryId": country_id +"/dfareporting:v3.0/DirectorySite/currencyId": currency_id +"/dfareporting:v3.0/DirectorySite/description": description +"/dfareporting:v3.0/DirectorySite/id": id +"/dfareporting:v3.0/DirectorySite/idDimensionValue": id_dimension_value +"/dfareporting:v3.0/DirectorySite/inpageTagFormats": inpage_tag_formats +"/dfareporting:v3.0/DirectorySite/inpageTagFormats/inpage_tag_format": inpage_tag_format +"/dfareporting:v3.0/DirectorySite/interstitialTagFormats": interstitial_tag_formats +"/dfareporting:v3.0/DirectorySite/interstitialTagFormats/interstitial_tag_format": interstitial_tag_format +"/dfareporting:v3.0/DirectorySite/kind": kind +"/dfareporting:v3.0/DirectorySite/name": name +"/dfareporting:v3.0/DirectorySite/parentId": parent_id +"/dfareporting:v3.0/DirectorySite/settings": settings +"/dfareporting:v3.0/DirectorySite/url": url +"/dfareporting:v3.0/DirectorySiteContact": directory_site_contact +"/dfareporting:v3.0/DirectorySiteContact/address": address +"/dfareporting:v3.0/DirectorySiteContact/email": email +"/dfareporting:v3.0/DirectorySiteContact/firstName": first_name +"/dfareporting:v3.0/DirectorySiteContact/id": id +"/dfareporting:v3.0/DirectorySiteContact/kind": kind +"/dfareporting:v3.0/DirectorySiteContact/lastName": last_name +"/dfareporting:v3.0/DirectorySiteContact/phone": phone +"/dfareporting:v3.0/DirectorySiteContact/role": role +"/dfareporting:v3.0/DirectorySiteContact/title": title +"/dfareporting:v3.0/DirectorySiteContact/type": type +"/dfareporting:v3.0/DirectorySiteContactAssignment": directory_site_contact_assignment +"/dfareporting:v3.0/DirectorySiteContactAssignment/contactId": contact_id +"/dfareporting:v3.0/DirectorySiteContactAssignment/visibility": visibility +"/dfareporting:v3.0/DirectorySiteContactsListResponse": directory_site_contacts_list_response +"/dfareporting:v3.0/DirectorySiteContactsListResponse/directorySiteContacts": directory_site_contacts +"/dfareporting:v3.0/DirectorySiteContactsListResponse/directorySiteContacts/directory_site_contact": directory_site_contact +"/dfareporting:v3.0/DirectorySiteContactsListResponse/kind": kind +"/dfareporting:v3.0/DirectorySiteContactsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/DirectorySiteSettings": directory_site_settings +"/dfareporting:v3.0/DirectorySiteSettings/activeViewOptOut": active_view_opt_out +"/dfareporting:v3.0/DirectorySiteSettings/dfpSettings": dfp_settings +"/dfareporting:v3.0/DirectorySiteSettings/instreamVideoPlacementAccepted": instream_video_placement_accepted +"/dfareporting:v3.0/DirectorySiteSettings/interstitialPlacementAccepted": interstitial_placement_accepted +"/dfareporting:v3.0/DirectorySiteSettings/nielsenOcrOptOut": nielsen_ocr_opt_out +"/dfareporting:v3.0/DirectorySiteSettings/verificationTagOptOut": verification_tag_opt_out +"/dfareporting:v3.0/DirectorySiteSettings/videoActiveViewOptOut": video_active_view_opt_out +"/dfareporting:v3.0/DirectorySitesListResponse": directory_sites_list_response +"/dfareporting:v3.0/DirectorySitesListResponse/directorySites": directory_sites +"/dfareporting:v3.0/DirectorySitesListResponse/directorySites/directory_site": directory_site +"/dfareporting:v3.0/DirectorySitesListResponse/kind": kind +"/dfareporting:v3.0/DirectorySitesListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/DynamicTargetingKey": dynamic_targeting_key +"/dfareporting:v3.0/DynamicTargetingKey/kind": kind +"/dfareporting:v3.0/DynamicTargetingKey/name": name +"/dfareporting:v3.0/DynamicTargetingKey/objectId": object_id_prop +"/dfareporting:v3.0/DynamicTargetingKey/objectType": object_type +"/dfareporting:v3.0/DynamicTargetingKeysListResponse": dynamic_targeting_keys_list_response +"/dfareporting:v3.0/DynamicTargetingKeysListResponse/dynamicTargetingKeys": dynamic_targeting_keys +"/dfareporting:v3.0/DynamicTargetingKeysListResponse/dynamicTargetingKeys/dynamic_targeting_key": dynamic_targeting_key +"/dfareporting:v3.0/DynamicTargetingKeysListResponse/kind": kind +"/dfareporting:v3.0/EncryptionInfo": encryption_info +"/dfareporting:v3.0/EncryptionInfo/encryptionEntityId": encryption_entity_id +"/dfareporting:v3.0/EncryptionInfo/encryptionEntityType": encryption_entity_type +"/dfareporting:v3.0/EncryptionInfo/encryptionSource": encryption_source +"/dfareporting:v3.0/EncryptionInfo/kind": kind +"/dfareporting:v3.0/EventTag": event_tag +"/dfareporting:v3.0/EventTag/accountId": account_id +"/dfareporting:v3.0/EventTag/advertiserId": advertiser_id +"/dfareporting:v3.0/EventTag/advertiserIdDimensionValue": advertiser_id_dimension_value +"/dfareporting:v3.0/EventTag/campaignId": campaign_id +"/dfareporting:v3.0/EventTag/campaignIdDimensionValue": campaign_id_dimension_value +"/dfareporting:v3.0/EventTag/enabledByDefault": enabled_by_default +"/dfareporting:v3.0/EventTag/excludeFromAdxRequests": exclude_from_adx_requests +"/dfareporting:v3.0/EventTag/id": id +"/dfareporting:v3.0/EventTag/kind": kind +"/dfareporting:v3.0/EventTag/name": name +"/dfareporting:v3.0/EventTag/siteFilterType": site_filter_type +"/dfareporting:v3.0/EventTag/siteIds": site_ids +"/dfareporting:v3.0/EventTag/siteIds/site_id": site_id +"/dfareporting:v3.0/EventTag/sslCompliant": ssl_compliant +"/dfareporting:v3.0/EventTag/status": status +"/dfareporting:v3.0/EventTag/subaccountId": subaccount_id +"/dfareporting:v3.0/EventTag/type": type +"/dfareporting:v3.0/EventTag/url": url +"/dfareporting:v3.0/EventTag/urlEscapeLevels": url_escape_levels +"/dfareporting:v3.0/EventTagOverride": event_tag_override +"/dfareporting:v3.0/EventTagOverride/enabled": enabled +"/dfareporting:v3.0/EventTagOverride/id": id +"/dfareporting:v3.0/EventTagsListResponse": event_tags_list_response +"/dfareporting:v3.0/EventTagsListResponse/eventTags": event_tags +"/dfareporting:v3.0/EventTagsListResponse/eventTags/event_tag": event_tag +"/dfareporting:v3.0/EventTagsListResponse/kind": kind +"/dfareporting:v3.0/File": file +"/dfareporting:v3.0/File/dateRange": date_range +"/dfareporting:v3.0/File/etag": etag +"/dfareporting:v3.0/File/fileName": file_name +"/dfareporting:v3.0/File/format": format +"/dfareporting:v3.0/File/id": id +"/dfareporting:v3.0/File/kind": kind +"/dfareporting:v3.0/File/lastModifiedTime": last_modified_time +"/dfareporting:v3.0/File/reportId": report_id +"/dfareporting:v3.0/File/status": status +"/dfareporting:v3.0/File/urls": urls +"/dfareporting:v3.0/File/urls/apiUrl": api_url +"/dfareporting:v3.0/File/urls/browserUrl": browser_url +"/dfareporting:v3.0/FileList": file_list +"/dfareporting:v3.0/FileList/etag": etag +"/dfareporting:v3.0/FileList/items": items +"/dfareporting:v3.0/FileList/items/item": item +"/dfareporting:v3.0/FileList/kind": kind +"/dfareporting:v3.0/FileList/nextPageToken": next_page_token +"/dfareporting:v3.0/Flight": flight +"/dfareporting:v3.0/Flight/endDate": end_date +"/dfareporting:v3.0/Flight/rateOrCost": rate_or_cost +"/dfareporting:v3.0/Flight/startDate": start_date +"/dfareporting:v3.0/Flight/units": units +"/dfareporting:v3.0/FloodlightActivitiesGenerateTagResponse": floodlight_activities_generate_tag_response +"/dfareporting:v3.0/FloodlightActivitiesGenerateTagResponse/floodlightActivityTag": floodlight_activity_tag +"/dfareporting:v3.0/FloodlightActivitiesGenerateTagResponse/globalSiteTagGlobalSnippet": global_site_tag_global_snippet +"/dfareporting:v3.0/FloodlightActivitiesGenerateTagResponse/kind": kind +"/dfareporting:v3.0/FloodlightActivitiesListResponse": floodlight_activities_list_response +"/dfareporting:v3.0/FloodlightActivitiesListResponse/floodlightActivities": floodlight_activities +"/dfareporting:v3.0/FloodlightActivitiesListResponse/floodlightActivities/floodlight_activity": floodlight_activity +"/dfareporting:v3.0/FloodlightActivitiesListResponse/kind": kind +"/dfareporting:v3.0/FloodlightActivitiesListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/FloodlightActivity": floodlight_activity +"/dfareporting:v3.0/FloodlightActivity/accountId": account_id +"/dfareporting:v3.0/FloodlightActivity/advertiserId": advertiser_id +"/dfareporting:v3.0/FloodlightActivity/advertiserIdDimensionValue": advertiser_id_dimension_value +"/dfareporting:v3.0/FloodlightActivity/cacheBustingType": cache_busting_type +"/dfareporting:v3.0/FloodlightActivity/countingMethod": counting_method +"/dfareporting:v3.0/FloodlightActivity/defaultTags": default_tags +"/dfareporting:v3.0/FloodlightActivity/defaultTags/default_tag": default_tag +"/dfareporting:v3.0/FloodlightActivity/expectedUrl": expected_url +"/dfareporting:v3.0/FloodlightActivity/floodlightActivityGroupId": floodlight_activity_group_id +"/dfareporting:v3.0/FloodlightActivity/floodlightActivityGroupName": floodlight_activity_group_name +"/dfareporting:v3.0/FloodlightActivity/floodlightActivityGroupTagString": floodlight_activity_group_tag_string +"/dfareporting:v3.0/FloodlightActivity/floodlightActivityGroupType": floodlight_activity_group_type +"/dfareporting:v3.0/FloodlightActivity/floodlightConfigurationId": floodlight_configuration_id +"/dfareporting:v3.0/FloodlightActivity/floodlightConfigurationIdDimensionValue": floodlight_configuration_id_dimension_value +"/dfareporting:v3.0/FloodlightActivity/floodlightTagType": floodlight_tag_type +"/dfareporting:v3.0/FloodlightActivity/hidden": hidden +"/dfareporting:v3.0/FloodlightActivity/id": id +"/dfareporting:v3.0/FloodlightActivity/idDimensionValue": id_dimension_value +"/dfareporting:v3.0/FloodlightActivity/kind": kind +"/dfareporting:v3.0/FloodlightActivity/name": name +"/dfareporting:v3.0/FloodlightActivity/notes": notes +"/dfareporting:v3.0/FloodlightActivity/publisherTags": publisher_tags +"/dfareporting:v3.0/FloodlightActivity/publisherTags/publisher_tag": publisher_tag +"/dfareporting:v3.0/FloodlightActivity/secure": secure +"/dfareporting:v3.0/FloodlightActivity/sslCompliant": ssl_compliant +"/dfareporting:v3.0/FloodlightActivity/sslRequired": ssl_required +"/dfareporting:v3.0/FloodlightActivity/subaccountId": subaccount_id +"/dfareporting:v3.0/FloodlightActivity/tagFormat": tag_format +"/dfareporting:v3.0/FloodlightActivity/tagString": tag_string +"/dfareporting:v3.0/FloodlightActivity/userDefinedVariableTypes": user_defined_variable_types +"/dfareporting:v3.0/FloodlightActivity/userDefinedVariableTypes/user_defined_variable_type": user_defined_variable_type +"/dfareporting:v3.0/FloodlightActivityDynamicTag": floodlight_activity_dynamic_tag +"/dfareporting:v3.0/FloodlightActivityDynamicTag/id": id +"/dfareporting:v3.0/FloodlightActivityDynamicTag/name": name +"/dfareporting:v3.0/FloodlightActivityDynamicTag/tag": tag +"/dfareporting:v3.0/FloodlightActivityGroup": floodlight_activity_group +"/dfareporting:v3.0/FloodlightActivityGroup/accountId": account_id +"/dfareporting:v3.0/FloodlightActivityGroup/advertiserId": advertiser_id +"/dfareporting:v3.0/FloodlightActivityGroup/advertiserIdDimensionValue": advertiser_id_dimension_value +"/dfareporting:v3.0/FloodlightActivityGroup/floodlightConfigurationId": floodlight_configuration_id +"/dfareporting:v3.0/FloodlightActivityGroup/floodlightConfigurationIdDimensionValue": floodlight_configuration_id_dimension_value +"/dfareporting:v3.0/FloodlightActivityGroup/id": id +"/dfareporting:v3.0/FloodlightActivityGroup/idDimensionValue": id_dimension_value +"/dfareporting:v3.0/FloodlightActivityGroup/kind": kind +"/dfareporting:v3.0/FloodlightActivityGroup/name": name +"/dfareporting:v3.0/FloodlightActivityGroup/subaccountId": subaccount_id +"/dfareporting:v3.0/FloodlightActivityGroup/tagString": tag_string +"/dfareporting:v3.0/FloodlightActivityGroup/type": type +"/dfareporting:v3.0/FloodlightActivityGroupsListResponse": floodlight_activity_groups_list_response +"/dfareporting:v3.0/FloodlightActivityGroupsListResponse/floodlightActivityGroups": floodlight_activity_groups +"/dfareporting:v3.0/FloodlightActivityGroupsListResponse/floodlightActivityGroups/floodlight_activity_group": floodlight_activity_group +"/dfareporting:v3.0/FloodlightActivityGroupsListResponse/kind": kind +"/dfareporting:v3.0/FloodlightActivityGroupsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/FloodlightActivityPublisherDynamicTag": floodlight_activity_publisher_dynamic_tag +"/dfareporting:v3.0/FloodlightActivityPublisherDynamicTag/clickThrough": click_through +"/dfareporting:v3.0/FloodlightActivityPublisherDynamicTag/directorySiteId": directory_site_id +"/dfareporting:v3.0/FloodlightActivityPublisherDynamicTag/dynamicTag": dynamic_tag +"/dfareporting:v3.0/FloodlightActivityPublisherDynamicTag/siteId": site_id +"/dfareporting:v3.0/FloodlightActivityPublisherDynamicTag/siteIdDimensionValue": site_id_dimension_value +"/dfareporting:v3.0/FloodlightActivityPublisherDynamicTag/viewThrough": view_through +"/dfareporting:v3.0/FloodlightConfiguration": floodlight_configuration +"/dfareporting:v3.0/FloodlightConfiguration/accountId": account_id +"/dfareporting:v3.0/FloodlightConfiguration/advertiserId": advertiser_id +"/dfareporting:v3.0/FloodlightConfiguration/advertiserIdDimensionValue": advertiser_id_dimension_value +"/dfareporting:v3.0/FloodlightConfiguration/analyticsDataSharingEnabled": analytics_data_sharing_enabled +"/dfareporting:v3.0/FloodlightConfiguration/exposureToConversionEnabled": exposure_to_conversion_enabled +"/dfareporting:v3.0/FloodlightConfiguration/firstDayOfWeek": first_day_of_week +"/dfareporting:v3.0/FloodlightConfiguration/id": id +"/dfareporting:v3.0/FloodlightConfiguration/idDimensionValue": id_dimension_value +"/dfareporting:v3.0/FloodlightConfiguration/inAppAttributionTrackingEnabled": in_app_attribution_tracking_enabled +"/dfareporting:v3.0/FloodlightConfiguration/kind": kind +"/dfareporting:v3.0/FloodlightConfiguration/lookbackConfiguration": lookback_configuration +"/dfareporting:v3.0/FloodlightConfiguration/naturalSearchConversionAttributionOption": natural_search_conversion_attribution_option +"/dfareporting:v3.0/FloodlightConfiguration/omnitureSettings": omniture_settings +"/dfareporting:v3.0/FloodlightConfiguration/subaccountId": subaccount_id +"/dfareporting:v3.0/FloodlightConfiguration/tagSettings": tag_settings +"/dfareporting:v3.0/FloodlightConfiguration/thirdPartyAuthenticationTokens": third_party_authentication_tokens +"/dfareporting:v3.0/FloodlightConfiguration/thirdPartyAuthenticationTokens/third_party_authentication_token": third_party_authentication_token +"/dfareporting:v3.0/FloodlightConfiguration/userDefinedVariableConfigurations": user_defined_variable_configurations +"/dfareporting:v3.0/FloodlightConfiguration/userDefinedVariableConfigurations/user_defined_variable_configuration": user_defined_variable_configuration +"/dfareporting:v3.0/FloodlightConfigurationsListResponse": floodlight_configurations_list_response +"/dfareporting:v3.0/FloodlightConfigurationsListResponse/floodlightConfigurations": floodlight_configurations +"/dfareporting:v3.0/FloodlightConfigurationsListResponse/floodlightConfigurations/floodlight_configuration": floodlight_configuration +"/dfareporting:v3.0/FloodlightConfigurationsListResponse/kind": kind +"/dfareporting:v3.0/FloodlightReportCompatibleFields": floodlight_report_compatible_fields +"/dfareporting:v3.0/FloodlightReportCompatibleFields/dimensionFilters": dimension_filters +"/dfareporting:v3.0/FloodlightReportCompatibleFields/dimensionFilters/dimension_filter": dimension_filter +"/dfareporting:v3.0/FloodlightReportCompatibleFields/dimensions": dimensions +"/dfareporting:v3.0/FloodlightReportCompatibleFields/dimensions/dimension": dimension +"/dfareporting:v3.0/FloodlightReportCompatibleFields/kind": kind +"/dfareporting:v3.0/FloodlightReportCompatibleFields/metrics": metrics +"/dfareporting:v3.0/FloodlightReportCompatibleFields/metrics/metric": metric +"/dfareporting:v3.0/FrequencyCap": frequency_cap +"/dfareporting:v3.0/FrequencyCap/duration": duration +"/dfareporting:v3.0/FrequencyCap/impressions": impressions +"/dfareporting:v3.0/FsCommand": fs_command +"/dfareporting:v3.0/FsCommand/left": left +"/dfareporting:v3.0/FsCommand/positionOption": position_option +"/dfareporting:v3.0/FsCommand/top": top +"/dfareporting:v3.0/FsCommand/windowHeight": window_height +"/dfareporting:v3.0/FsCommand/windowWidth": window_width +"/dfareporting:v3.0/GeoTargeting": geo_targeting +"/dfareporting:v3.0/GeoTargeting/cities": cities +"/dfareporting:v3.0/GeoTargeting/cities/city": city +"/dfareporting:v3.0/GeoTargeting/countries": countries +"/dfareporting:v3.0/GeoTargeting/countries/country": country +"/dfareporting:v3.0/GeoTargeting/excludeCountries": exclude_countries +"/dfareporting:v3.0/GeoTargeting/metros": metros +"/dfareporting:v3.0/GeoTargeting/metros/metro": metro +"/dfareporting:v3.0/GeoTargeting/postalCodes": postal_codes +"/dfareporting:v3.0/GeoTargeting/postalCodes/postal_code": postal_code +"/dfareporting:v3.0/GeoTargeting/regions": regions +"/dfareporting:v3.0/GeoTargeting/regions/region": region +"/dfareporting:v3.0/InventoryItem": inventory_item +"/dfareporting:v3.0/InventoryItem/accountId": account_id +"/dfareporting:v3.0/InventoryItem/adSlots": ad_slots +"/dfareporting:v3.0/InventoryItem/adSlots/ad_slot": ad_slot +"/dfareporting:v3.0/InventoryItem/advertiserId": advertiser_id +"/dfareporting:v3.0/InventoryItem/contentCategoryId": content_category_id +"/dfareporting:v3.0/InventoryItem/estimatedClickThroughRate": estimated_click_through_rate +"/dfareporting:v3.0/InventoryItem/estimatedConversionRate": estimated_conversion_rate +"/dfareporting:v3.0/InventoryItem/id": id +"/dfareporting:v3.0/InventoryItem/inPlan": in_plan +"/dfareporting:v3.0/InventoryItem/kind": kind +"/dfareporting:v3.0/InventoryItem/lastModifiedInfo": last_modified_info +"/dfareporting:v3.0/InventoryItem/name": name +"/dfareporting:v3.0/InventoryItem/negotiationChannelId": negotiation_channel_id +"/dfareporting:v3.0/InventoryItem/orderId": order_id +"/dfareporting:v3.0/InventoryItem/placementStrategyId": placement_strategy_id +"/dfareporting:v3.0/InventoryItem/pricing": pricing +"/dfareporting:v3.0/InventoryItem/projectId": project_id +"/dfareporting:v3.0/InventoryItem/rfpId": rfp_id +"/dfareporting:v3.0/InventoryItem/siteId": site_id +"/dfareporting:v3.0/InventoryItem/subaccountId": subaccount_id +"/dfareporting:v3.0/InventoryItem/type": type +"/dfareporting:v3.0/InventoryItemsListResponse": inventory_items_list_response +"/dfareporting:v3.0/InventoryItemsListResponse/inventoryItems": inventory_items +"/dfareporting:v3.0/InventoryItemsListResponse/inventoryItems/inventory_item": inventory_item +"/dfareporting:v3.0/InventoryItemsListResponse/kind": kind +"/dfareporting:v3.0/InventoryItemsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/KeyValueTargetingExpression": key_value_targeting_expression +"/dfareporting:v3.0/KeyValueTargetingExpression/expression": expression +"/dfareporting:v3.0/LandingPage": landing_page +"/dfareporting:v3.0/LandingPage/advertiserId": advertiser_id +"/dfareporting:v3.0/LandingPage/archived": archived +"/dfareporting:v3.0/LandingPage/id": id +"/dfareporting:v3.0/LandingPage/kind": kind +"/dfareporting:v3.0/LandingPage/name": name +"/dfareporting:v3.0/LandingPage/url": url +"/dfareporting:v3.0/Language": language +"/dfareporting:v3.0/Language/id": id +"/dfareporting:v3.0/Language/kind": kind +"/dfareporting:v3.0/Language/languageCode": language_code +"/dfareporting:v3.0/Language/name": name +"/dfareporting:v3.0/LanguageTargeting": language_targeting +"/dfareporting:v3.0/LanguageTargeting/languages": languages +"/dfareporting:v3.0/LanguageTargeting/languages/language": language +"/dfareporting:v3.0/LanguagesListResponse": languages_list_response +"/dfareporting:v3.0/LanguagesListResponse/kind": kind +"/dfareporting:v3.0/LanguagesListResponse/languages": languages +"/dfareporting:v3.0/LanguagesListResponse/languages/language": language +"/dfareporting:v3.0/LastModifiedInfo": last_modified_info +"/dfareporting:v3.0/LastModifiedInfo/time": time +"/dfareporting:v3.0/ListPopulationClause": list_population_clause +"/dfareporting:v3.0/ListPopulationClause/terms": terms +"/dfareporting:v3.0/ListPopulationClause/terms/term": term +"/dfareporting:v3.0/ListPopulationRule": list_population_rule +"/dfareporting:v3.0/ListPopulationRule/floodlightActivityId": floodlight_activity_id +"/dfareporting:v3.0/ListPopulationRule/floodlightActivityName": floodlight_activity_name +"/dfareporting:v3.0/ListPopulationRule/listPopulationClauses": list_population_clauses +"/dfareporting:v3.0/ListPopulationRule/listPopulationClauses/list_population_clause": list_population_clause +"/dfareporting:v3.0/ListPopulationTerm": list_population_term +"/dfareporting:v3.0/ListPopulationTerm/contains": contains +"/dfareporting:v3.0/ListPopulationTerm/negation": negation +"/dfareporting:v3.0/ListPopulationTerm/operator": operator +"/dfareporting:v3.0/ListPopulationTerm/remarketingListId": remarketing_list_id +"/dfareporting:v3.0/ListPopulationTerm/type": type +"/dfareporting:v3.0/ListPopulationTerm/value": value +"/dfareporting:v3.0/ListPopulationTerm/variableFriendlyName": variable_friendly_name +"/dfareporting:v3.0/ListPopulationTerm/variableName": variable_name +"/dfareporting:v3.0/ListTargetingExpression": list_targeting_expression +"/dfareporting:v3.0/ListTargetingExpression/expression": expression +"/dfareporting:v3.0/LookbackConfiguration": lookback_configuration +"/dfareporting:v3.0/LookbackConfiguration/clickDuration": click_duration +"/dfareporting:v3.0/LookbackConfiguration/postImpressionActivitiesDuration": post_impression_activities_duration +"/dfareporting:v3.0/Metric": metric +"/dfareporting:v3.0/Metric/kind": kind +"/dfareporting:v3.0/Metric/name": name +"/dfareporting:v3.0/Metro": metro +"/dfareporting:v3.0/Metro/countryCode": country_code +"/dfareporting:v3.0/Metro/countryDartId": country_dart_id +"/dfareporting:v3.0/Metro/dartId": dart_id +"/dfareporting:v3.0/Metro/dmaId": dma_id +"/dfareporting:v3.0/Metro/kind": kind +"/dfareporting:v3.0/Metro/metroCode": metro_code +"/dfareporting:v3.0/Metro/name": name +"/dfareporting:v3.0/MetrosListResponse": metros_list_response +"/dfareporting:v3.0/MetrosListResponse/kind": kind +"/dfareporting:v3.0/MetrosListResponse/metros": metros +"/dfareporting:v3.0/MetrosListResponse/metros/metro": metro +"/dfareporting:v3.0/MobileCarrier": mobile_carrier +"/dfareporting:v3.0/MobileCarrier/countryCode": country_code +"/dfareporting:v3.0/MobileCarrier/countryDartId": country_dart_id +"/dfareporting:v3.0/MobileCarrier/id": id +"/dfareporting:v3.0/MobileCarrier/kind": kind +"/dfareporting:v3.0/MobileCarrier/name": name +"/dfareporting:v3.0/MobileCarriersListResponse": mobile_carriers_list_response +"/dfareporting:v3.0/MobileCarriersListResponse/kind": kind +"/dfareporting:v3.0/MobileCarriersListResponse/mobileCarriers": mobile_carriers +"/dfareporting:v3.0/MobileCarriersListResponse/mobileCarriers/mobile_carrier": mobile_carrier +"/dfareporting:v3.0/ObjectFilter": object_filter +"/dfareporting:v3.0/ObjectFilter/kind": kind +"/dfareporting:v3.0/ObjectFilter/objectIds": object_ids +"/dfareporting:v3.0/ObjectFilter/objectIds/object_id": object_id_prop +"/dfareporting:v3.0/ObjectFilter/status": status +"/dfareporting:v3.0/OffsetPosition": offset_position +"/dfareporting:v3.0/OffsetPosition/left": left +"/dfareporting:v3.0/OffsetPosition/top": top +"/dfareporting:v3.0/OmnitureSettings": omniture_settings +"/dfareporting:v3.0/OmnitureSettings/omnitureCostDataEnabled": omniture_cost_data_enabled +"/dfareporting:v3.0/OmnitureSettings/omnitureIntegrationEnabled": omniture_integration_enabled +"/dfareporting:v3.0/OperatingSystem": operating_system +"/dfareporting:v3.0/OperatingSystem/dartId": dart_id +"/dfareporting:v3.0/OperatingSystem/desktop": desktop +"/dfareporting:v3.0/OperatingSystem/kind": kind +"/dfareporting:v3.0/OperatingSystem/mobile": mobile +"/dfareporting:v3.0/OperatingSystem/name": name +"/dfareporting:v3.0/OperatingSystemVersion": operating_system_version +"/dfareporting:v3.0/OperatingSystemVersion/id": id +"/dfareporting:v3.0/OperatingSystemVersion/kind": kind +"/dfareporting:v3.0/OperatingSystemVersion/majorVersion": major_version +"/dfareporting:v3.0/OperatingSystemVersion/minorVersion": minor_version +"/dfareporting:v3.0/OperatingSystemVersion/name": name +"/dfareporting:v3.0/OperatingSystemVersion/operatingSystem": operating_system +"/dfareporting:v3.0/OperatingSystemVersionsListResponse": operating_system_versions_list_response +"/dfareporting:v3.0/OperatingSystemVersionsListResponse/kind": kind +"/dfareporting:v3.0/OperatingSystemVersionsListResponse/operatingSystemVersions": operating_system_versions +"/dfareporting:v3.0/OperatingSystemVersionsListResponse/operatingSystemVersions/operating_system_version": operating_system_version +"/dfareporting:v3.0/OperatingSystemsListResponse": operating_systems_list_response +"/dfareporting:v3.0/OperatingSystemsListResponse/kind": kind +"/dfareporting:v3.0/OperatingSystemsListResponse/operatingSystems": operating_systems +"/dfareporting:v3.0/OperatingSystemsListResponse/operatingSystems/operating_system": operating_system +"/dfareporting:v3.0/OptimizationActivity": optimization_activity +"/dfareporting:v3.0/OptimizationActivity/floodlightActivityId": floodlight_activity_id +"/dfareporting:v3.0/OptimizationActivity/floodlightActivityIdDimensionValue": floodlight_activity_id_dimension_value +"/dfareporting:v3.0/OptimizationActivity/weight": weight +"/dfareporting:v3.0/Order": order +"/dfareporting:v3.0/Order/accountId": account_id +"/dfareporting:v3.0/Order/advertiserId": advertiser_id +"/dfareporting:v3.0/Order/approverUserProfileIds": approver_user_profile_ids +"/dfareporting:v3.0/Order/approverUserProfileIds/approver_user_profile_id": approver_user_profile_id +"/dfareporting:v3.0/Order/buyerInvoiceId": buyer_invoice_id +"/dfareporting:v3.0/Order/buyerOrganizationName": buyer_organization_name +"/dfareporting:v3.0/Order/comments": comments +"/dfareporting:v3.0/Order/contacts": contacts +"/dfareporting:v3.0/Order/contacts/contact": contact +"/dfareporting:v3.0/Order/id": id +"/dfareporting:v3.0/Order/kind": kind +"/dfareporting:v3.0/Order/lastModifiedInfo": last_modified_info +"/dfareporting:v3.0/Order/name": name +"/dfareporting:v3.0/Order/notes": notes +"/dfareporting:v3.0/Order/planningTermId": planning_term_id +"/dfareporting:v3.0/Order/projectId": project_id +"/dfareporting:v3.0/Order/sellerOrderId": seller_order_id +"/dfareporting:v3.0/Order/sellerOrganizationName": seller_organization_name +"/dfareporting:v3.0/Order/siteId": site_id +"/dfareporting:v3.0/Order/siteId/site_id": site_id +"/dfareporting:v3.0/Order/siteNames": site_names +"/dfareporting:v3.0/Order/siteNames/site_name": site_name +"/dfareporting:v3.0/Order/subaccountId": subaccount_id +"/dfareporting:v3.0/Order/termsAndConditions": terms_and_conditions +"/dfareporting:v3.0/OrderContact": order_contact +"/dfareporting:v3.0/OrderContact/contactInfo": contact_info +"/dfareporting:v3.0/OrderContact/contactName": contact_name +"/dfareporting:v3.0/OrderContact/contactTitle": contact_title +"/dfareporting:v3.0/OrderContact/contactType": contact_type +"/dfareporting:v3.0/OrderContact/signatureUserProfileId": signature_user_profile_id +"/dfareporting:v3.0/OrderDocument": order_document +"/dfareporting:v3.0/OrderDocument/accountId": account_id +"/dfareporting:v3.0/OrderDocument/advertiserId": advertiser_id +"/dfareporting:v3.0/OrderDocument/amendedOrderDocumentId": amended_order_document_id +"/dfareporting:v3.0/OrderDocument/approvedByUserProfileIds": approved_by_user_profile_ids +"/dfareporting:v3.0/OrderDocument/approvedByUserProfileIds/approved_by_user_profile_id": approved_by_user_profile_id +"/dfareporting:v3.0/OrderDocument/cancelled": cancelled +"/dfareporting:v3.0/OrderDocument/createdInfo": created_info +"/dfareporting:v3.0/OrderDocument/effectiveDate": effective_date +"/dfareporting:v3.0/OrderDocument/id": id +"/dfareporting:v3.0/OrderDocument/kind": kind +"/dfareporting:v3.0/OrderDocument/lastSentRecipients": last_sent_recipients +"/dfareporting:v3.0/OrderDocument/lastSentRecipients/last_sent_recipient": last_sent_recipient +"/dfareporting:v3.0/OrderDocument/lastSentTime": last_sent_time +"/dfareporting:v3.0/OrderDocument/orderId": order_id +"/dfareporting:v3.0/OrderDocument/projectId": project_id +"/dfareporting:v3.0/OrderDocument/signed": signed +"/dfareporting:v3.0/OrderDocument/subaccountId": subaccount_id +"/dfareporting:v3.0/OrderDocument/title": title +"/dfareporting:v3.0/OrderDocument/type": type +"/dfareporting:v3.0/OrderDocumentsListResponse": order_documents_list_response +"/dfareporting:v3.0/OrderDocumentsListResponse/kind": kind +"/dfareporting:v3.0/OrderDocumentsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/OrderDocumentsListResponse/orderDocuments": order_documents +"/dfareporting:v3.0/OrderDocumentsListResponse/orderDocuments/order_document": order_document +"/dfareporting:v3.0/OrdersListResponse": orders_list_response +"/dfareporting:v3.0/OrdersListResponse/kind": kind +"/dfareporting:v3.0/OrdersListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/OrdersListResponse/orders": orders +"/dfareporting:v3.0/OrdersListResponse/orders/order": order +"/dfareporting:v3.0/PathToConversionReportCompatibleFields": path_to_conversion_report_compatible_fields +"/dfareporting:v3.0/PathToConversionReportCompatibleFields/conversionDimensions": conversion_dimensions +"/dfareporting:v3.0/PathToConversionReportCompatibleFields/conversionDimensions/conversion_dimension": conversion_dimension +"/dfareporting:v3.0/PathToConversionReportCompatibleFields/customFloodlightVariables": custom_floodlight_variables +"/dfareporting:v3.0/PathToConversionReportCompatibleFields/customFloodlightVariables/custom_floodlight_variable": custom_floodlight_variable +"/dfareporting:v3.0/PathToConversionReportCompatibleFields/kind": kind +"/dfareporting:v3.0/PathToConversionReportCompatibleFields/metrics": metrics +"/dfareporting:v3.0/PathToConversionReportCompatibleFields/metrics/metric": metric +"/dfareporting:v3.0/PathToConversionReportCompatibleFields/perInteractionDimensions": per_interaction_dimensions +"/dfareporting:v3.0/PathToConversionReportCompatibleFields/perInteractionDimensions/per_interaction_dimension": per_interaction_dimension +"/dfareporting:v3.0/Placement": placement +"/dfareporting:v3.0/Placement/accountId": account_id +"/dfareporting:v3.0/Placement/adBlockingOptOut": ad_blocking_opt_out +"/dfareporting:v3.0/Placement/advertiserId": advertiser_id +"/dfareporting:v3.0/Placement/advertiserIdDimensionValue": advertiser_id_dimension_value +"/dfareporting:v3.0/Placement/archived": archived +"/dfareporting:v3.0/Placement/campaignId": campaign_id +"/dfareporting:v3.0/Placement/campaignIdDimensionValue": campaign_id_dimension_value +"/dfareporting:v3.0/Placement/comment": comment +"/dfareporting:v3.0/Placement/compatibility": compatibility +"/dfareporting:v3.0/Placement/contentCategoryId": content_category_id +"/dfareporting:v3.0/Placement/createInfo": create_info +"/dfareporting:v3.0/Placement/directorySiteId": directory_site_id +"/dfareporting:v3.0/Placement/directorySiteIdDimensionValue": directory_site_id_dimension_value +"/dfareporting:v3.0/Placement/externalId": external_id +"/dfareporting:v3.0/Placement/id": id +"/dfareporting:v3.0/Placement/idDimensionValue": id_dimension_value +"/dfareporting:v3.0/Placement/keyName": key_name +"/dfareporting:v3.0/Placement/kind": kind +"/dfareporting:v3.0/Placement/lastModifiedInfo": last_modified_info +"/dfareporting:v3.0/Placement/lookbackConfiguration": lookback_configuration +"/dfareporting:v3.0/Placement/name": name +"/dfareporting:v3.0/Placement/paymentApproved": payment_approved +"/dfareporting:v3.0/Placement/paymentSource": payment_source +"/dfareporting:v3.0/Placement/placementGroupId": placement_group_id +"/dfareporting:v3.0/Placement/placementGroupIdDimensionValue": placement_group_id_dimension_value +"/dfareporting:v3.0/Placement/placementStrategyId": placement_strategy_id +"/dfareporting:v3.0/Placement/pricingSchedule": pricing_schedule +"/dfareporting:v3.0/Placement/primary": primary +"/dfareporting:v3.0/Placement/publisherUpdateInfo": publisher_update_info +"/dfareporting:v3.0/Placement/siteId": site_id +"/dfareporting:v3.0/Placement/siteIdDimensionValue": site_id_dimension_value +"/dfareporting:v3.0/Placement/size": size +"/dfareporting:v3.0/Placement/sslRequired": ssl_required +"/dfareporting:v3.0/Placement/status": status +"/dfareporting:v3.0/Placement/subaccountId": subaccount_id +"/dfareporting:v3.0/Placement/tagFormats": tag_formats +"/dfareporting:v3.0/Placement/tagFormats/tag_format": tag_format +"/dfareporting:v3.0/Placement/tagSetting": tag_setting +"/dfareporting:v3.0/Placement/videoActiveViewOptOut": video_active_view_opt_out +"/dfareporting:v3.0/Placement/videoSettings": video_settings +"/dfareporting:v3.0/Placement/vpaidAdapterChoice": vpaid_adapter_choice +"/dfareporting:v3.0/PlacementAssignment": placement_assignment +"/dfareporting:v3.0/PlacementAssignment/active": active +"/dfareporting:v3.0/PlacementAssignment/placementId": placement_id +"/dfareporting:v3.0/PlacementAssignment/placementIdDimensionValue": placement_id_dimension_value +"/dfareporting:v3.0/PlacementAssignment/sslRequired": ssl_required +"/dfareporting:v3.0/PlacementGroup": placement_group +"/dfareporting:v3.0/PlacementGroup/accountId": account_id +"/dfareporting:v3.0/PlacementGroup/advertiserId": advertiser_id +"/dfareporting:v3.0/PlacementGroup/advertiserIdDimensionValue": advertiser_id_dimension_value +"/dfareporting:v3.0/PlacementGroup/archived": archived +"/dfareporting:v3.0/PlacementGroup/campaignId": campaign_id +"/dfareporting:v3.0/PlacementGroup/campaignIdDimensionValue": campaign_id_dimension_value +"/dfareporting:v3.0/PlacementGroup/childPlacementIds": child_placement_ids +"/dfareporting:v3.0/PlacementGroup/childPlacementIds/child_placement_id": child_placement_id +"/dfareporting:v3.0/PlacementGroup/comment": comment +"/dfareporting:v3.0/PlacementGroup/contentCategoryId": content_category_id +"/dfareporting:v3.0/PlacementGroup/createInfo": create_info +"/dfareporting:v3.0/PlacementGroup/directorySiteId": directory_site_id +"/dfareporting:v3.0/PlacementGroup/directorySiteIdDimensionValue": directory_site_id_dimension_value +"/dfareporting:v3.0/PlacementGroup/externalId": external_id +"/dfareporting:v3.0/PlacementGroup/id": id +"/dfareporting:v3.0/PlacementGroup/idDimensionValue": id_dimension_value +"/dfareporting:v3.0/PlacementGroup/kind": kind +"/dfareporting:v3.0/PlacementGroup/lastModifiedInfo": last_modified_info +"/dfareporting:v3.0/PlacementGroup/name": name +"/dfareporting:v3.0/PlacementGroup/placementGroupType": placement_group_type +"/dfareporting:v3.0/PlacementGroup/placementStrategyId": placement_strategy_id +"/dfareporting:v3.0/PlacementGroup/pricingSchedule": pricing_schedule +"/dfareporting:v3.0/PlacementGroup/primaryPlacementId": primary_placement_id +"/dfareporting:v3.0/PlacementGroup/primaryPlacementIdDimensionValue": primary_placement_id_dimension_value +"/dfareporting:v3.0/PlacementGroup/siteId": site_id +"/dfareporting:v3.0/PlacementGroup/siteIdDimensionValue": site_id_dimension_value +"/dfareporting:v3.0/PlacementGroup/subaccountId": subaccount_id +"/dfareporting:v3.0/PlacementGroupsListResponse": placement_groups_list_response +"/dfareporting:v3.0/PlacementGroupsListResponse/kind": kind +"/dfareporting:v3.0/PlacementGroupsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/PlacementGroupsListResponse/placementGroups": placement_groups +"/dfareporting:v3.0/PlacementGroupsListResponse/placementGroups/placement_group": placement_group +"/dfareporting:v3.0/PlacementStrategiesListResponse": placement_strategies_list_response +"/dfareporting:v3.0/PlacementStrategiesListResponse/kind": kind +"/dfareporting:v3.0/PlacementStrategiesListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/PlacementStrategiesListResponse/placementStrategies": placement_strategies +"/dfareporting:v3.0/PlacementStrategiesListResponse/placementStrategies/placement_strategy": placement_strategy +"/dfareporting:v3.0/PlacementStrategy": placement_strategy +"/dfareporting:v3.0/PlacementStrategy/accountId": account_id +"/dfareporting:v3.0/PlacementStrategy/id": id +"/dfareporting:v3.0/PlacementStrategy/kind": kind +"/dfareporting:v3.0/PlacementStrategy/name": name +"/dfareporting:v3.0/PlacementTag": placement_tag +"/dfareporting:v3.0/PlacementTag/placementId": placement_id +"/dfareporting:v3.0/PlacementTag/tagDatas": tag_datas +"/dfareporting:v3.0/PlacementTag/tagDatas/tag_data": tag_data +"/dfareporting:v3.0/PlacementsGenerateTagsResponse": placements_generate_tags_response +"/dfareporting:v3.0/PlacementsGenerateTagsResponse/kind": kind +"/dfareporting:v3.0/PlacementsGenerateTagsResponse/placementTags": placement_tags +"/dfareporting:v3.0/PlacementsGenerateTagsResponse/placementTags/placement_tag": placement_tag +"/dfareporting:v3.0/PlacementsListResponse": placements_list_response +"/dfareporting:v3.0/PlacementsListResponse/kind": kind +"/dfareporting:v3.0/PlacementsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/PlacementsListResponse/placements": placements +"/dfareporting:v3.0/PlacementsListResponse/placements/placement": placement +"/dfareporting:v3.0/PlatformType": platform_type +"/dfareporting:v3.0/PlatformType/id": id +"/dfareporting:v3.0/PlatformType/kind": kind +"/dfareporting:v3.0/PlatformType/name": name +"/dfareporting:v3.0/PlatformTypesListResponse": platform_types_list_response +"/dfareporting:v3.0/PlatformTypesListResponse/kind": kind +"/dfareporting:v3.0/PlatformTypesListResponse/platformTypes": platform_types +"/dfareporting:v3.0/PlatformTypesListResponse/platformTypes/platform_type": platform_type +"/dfareporting:v3.0/PopupWindowProperties": popup_window_properties +"/dfareporting:v3.0/PopupWindowProperties/dimension": dimension +"/dfareporting:v3.0/PopupWindowProperties/offset": offset +"/dfareporting:v3.0/PopupWindowProperties/positionType": position_type +"/dfareporting:v3.0/PopupWindowProperties/showAddressBar": show_address_bar +"/dfareporting:v3.0/PopupWindowProperties/showMenuBar": show_menu_bar +"/dfareporting:v3.0/PopupWindowProperties/showScrollBar": show_scroll_bar +"/dfareporting:v3.0/PopupWindowProperties/showStatusBar": show_status_bar +"/dfareporting:v3.0/PopupWindowProperties/showToolBar": show_tool_bar +"/dfareporting:v3.0/PopupWindowProperties/title": title +"/dfareporting:v3.0/PostalCode": postal_code +"/dfareporting:v3.0/PostalCode/code": code +"/dfareporting:v3.0/PostalCode/countryCode": country_code +"/dfareporting:v3.0/PostalCode/countryDartId": country_dart_id +"/dfareporting:v3.0/PostalCode/id": id +"/dfareporting:v3.0/PostalCode/kind": kind +"/dfareporting:v3.0/PostalCodesListResponse": postal_codes_list_response +"/dfareporting:v3.0/PostalCodesListResponse/kind": kind +"/dfareporting:v3.0/PostalCodesListResponse/postalCodes": postal_codes +"/dfareporting:v3.0/PostalCodesListResponse/postalCodes/postal_code": postal_code +"/dfareporting:v3.0/Pricing": pricing +"/dfareporting:v3.0/Pricing/capCostType": cap_cost_type +"/dfareporting:v3.0/Pricing/endDate": end_date +"/dfareporting:v3.0/Pricing/flights": flights +"/dfareporting:v3.0/Pricing/flights/flight": flight +"/dfareporting:v3.0/Pricing/groupType": group_type +"/dfareporting:v3.0/Pricing/pricingType": pricing_type +"/dfareporting:v3.0/Pricing/startDate": start_date +"/dfareporting:v3.0/PricingSchedule": pricing_schedule +"/dfareporting:v3.0/PricingSchedule/capCostOption": cap_cost_option +"/dfareporting:v3.0/PricingSchedule/disregardOverdelivery": disregard_overdelivery +"/dfareporting:v3.0/PricingSchedule/endDate": end_date +"/dfareporting:v3.0/PricingSchedule/flighted": flighted +"/dfareporting:v3.0/PricingSchedule/floodlightActivityId": floodlight_activity_id +"/dfareporting:v3.0/PricingSchedule/pricingPeriods": pricing_periods +"/dfareporting:v3.0/PricingSchedule/pricingPeriods/pricing_period": pricing_period +"/dfareporting:v3.0/PricingSchedule/pricingType": pricing_type +"/dfareporting:v3.0/PricingSchedule/startDate": start_date +"/dfareporting:v3.0/PricingSchedule/testingStartDate": testing_start_date +"/dfareporting:v3.0/PricingSchedulePricingPeriod": pricing_schedule_pricing_period +"/dfareporting:v3.0/PricingSchedulePricingPeriod/endDate": end_date +"/dfareporting:v3.0/PricingSchedulePricingPeriod/pricingComment": pricing_comment +"/dfareporting:v3.0/PricingSchedulePricingPeriod/rateOrCostNanos": rate_or_cost_nanos +"/dfareporting:v3.0/PricingSchedulePricingPeriod/startDate": start_date +"/dfareporting:v3.0/PricingSchedulePricingPeriod/units": units +"/dfareporting:v3.0/Project": project +"/dfareporting:v3.0/Project/accountId": account_id +"/dfareporting:v3.0/Project/advertiserId": advertiser_id +"/dfareporting:v3.0/Project/audienceAgeGroup": audience_age_group +"/dfareporting:v3.0/Project/audienceGender": audience_gender +"/dfareporting:v3.0/Project/budget": budget +"/dfareporting:v3.0/Project/clientBillingCode": client_billing_code +"/dfareporting:v3.0/Project/clientName": client_name +"/dfareporting:v3.0/Project/endDate": end_date +"/dfareporting:v3.0/Project/id": id +"/dfareporting:v3.0/Project/kind": kind +"/dfareporting:v3.0/Project/lastModifiedInfo": last_modified_info +"/dfareporting:v3.0/Project/name": name +"/dfareporting:v3.0/Project/overview": overview +"/dfareporting:v3.0/Project/startDate": start_date +"/dfareporting:v3.0/Project/subaccountId": subaccount_id +"/dfareporting:v3.0/Project/targetClicks": target_clicks +"/dfareporting:v3.0/Project/targetConversions": target_conversions +"/dfareporting:v3.0/Project/targetCpaNanos": target_cpa_nanos +"/dfareporting:v3.0/Project/targetCpcNanos": target_cpc_nanos +"/dfareporting:v3.0/Project/targetCpmActiveViewNanos": target_cpm_active_view_nanos +"/dfareporting:v3.0/Project/targetCpmNanos": target_cpm_nanos +"/dfareporting:v3.0/Project/targetImpressions": target_impressions +"/dfareporting:v3.0/ProjectsListResponse": projects_list_response +"/dfareporting:v3.0/ProjectsListResponse/kind": kind +"/dfareporting:v3.0/ProjectsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/ProjectsListResponse/projects": projects +"/dfareporting:v3.0/ProjectsListResponse/projects/project": project +"/dfareporting:v3.0/ReachReportCompatibleFields": reach_report_compatible_fields +"/dfareporting:v3.0/ReachReportCompatibleFields/dimensionFilters": dimension_filters +"/dfareporting:v3.0/ReachReportCompatibleFields/dimensionFilters/dimension_filter": dimension_filter +"/dfareporting:v3.0/ReachReportCompatibleFields/dimensions": dimensions +"/dfareporting:v3.0/ReachReportCompatibleFields/dimensions/dimension": dimension +"/dfareporting:v3.0/ReachReportCompatibleFields/kind": kind +"/dfareporting:v3.0/ReachReportCompatibleFields/metrics": metrics +"/dfareporting:v3.0/ReachReportCompatibleFields/metrics/metric": metric +"/dfareporting:v3.0/ReachReportCompatibleFields/pivotedActivityMetrics": pivoted_activity_metrics +"/dfareporting:v3.0/ReachReportCompatibleFields/pivotedActivityMetrics/pivoted_activity_metric": pivoted_activity_metric +"/dfareporting:v3.0/ReachReportCompatibleFields/reachByFrequencyMetrics": reach_by_frequency_metrics +"/dfareporting:v3.0/ReachReportCompatibleFields/reachByFrequencyMetrics/reach_by_frequency_metric": reach_by_frequency_metric +"/dfareporting:v3.0/Recipient": recipient +"/dfareporting:v3.0/Recipient/deliveryType": delivery_type +"/dfareporting:v3.0/Recipient/email": email +"/dfareporting:v3.0/Recipient/kind": kind +"/dfareporting:v3.0/Region": region +"/dfareporting:v3.0/Region/countryCode": country_code +"/dfareporting:v3.0/Region/countryDartId": country_dart_id +"/dfareporting:v3.0/Region/dartId": dart_id +"/dfareporting:v3.0/Region/kind": kind +"/dfareporting:v3.0/Region/name": name +"/dfareporting:v3.0/Region/regionCode": region_code +"/dfareporting:v3.0/RegionsListResponse": regions_list_response +"/dfareporting:v3.0/RegionsListResponse/kind": kind +"/dfareporting:v3.0/RegionsListResponse/regions": regions +"/dfareporting:v3.0/RegionsListResponse/regions/region": region +"/dfareporting:v3.0/RemarketingList": remarketing_list +"/dfareporting:v3.0/RemarketingList/accountId": account_id +"/dfareporting:v3.0/RemarketingList/active": active +"/dfareporting:v3.0/RemarketingList/advertiserId": advertiser_id +"/dfareporting:v3.0/RemarketingList/advertiserIdDimensionValue": advertiser_id_dimension_value +"/dfareporting:v3.0/RemarketingList/description": description +"/dfareporting:v3.0/RemarketingList/id": id +"/dfareporting:v3.0/RemarketingList/kind": kind +"/dfareporting:v3.0/RemarketingList/lifeSpan": life_span +"/dfareporting:v3.0/RemarketingList/listPopulationRule": list_population_rule +"/dfareporting:v3.0/RemarketingList/listSize": list_size +"/dfareporting:v3.0/RemarketingList/listSource": list_source +"/dfareporting:v3.0/RemarketingList/name": name +"/dfareporting:v3.0/RemarketingList/subaccountId": subaccount_id +"/dfareporting:v3.0/RemarketingListShare": remarketing_list_share +"/dfareporting:v3.0/RemarketingListShare/kind": kind +"/dfareporting:v3.0/RemarketingListShare/remarketingListId": remarketing_list_id +"/dfareporting:v3.0/RemarketingListShare/sharedAccountIds": shared_account_ids +"/dfareporting:v3.0/RemarketingListShare/sharedAccountIds/shared_account_id": shared_account_id +"/dfareporting:v3.0/RemarketingListShare/sharedAdvertiserIds": shared_advertiser_ids +"/dfareporting:v3.0/RemarketingListShare/sharedAdvertiserIds/shared_advertiser_id": shared_advertiser_id +"/dfareporting:v3.0/RemarketingListsListResponse": remarketing_lists_list_response +"/dfareporting:v3.0/RemarketingListsListResponse/kind": kind +"/dfareporting:v3.0/RemarketingListsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/RemarketingListsListResponse/remarketingLists": remarketing_lists +"/dfareporting:v3.0/RemarketingListsListResponse/remarketingLists/remarketing_list": remarketing_list +"/dfareporting:v3.0/Report": report +"/dfareporting:v3.0/Report/accountId": account_id +"/dfareporting:v3.0/Report/criteria": criteria +"/dfareporting:v3.0/Report/criteria/activities": activities +"/dfareporting:v3.0/Report/criteria/customRichMediaEvents": custom_rich_media_events +"/dfareporting:v3.0/Report/criteria/dateRange": date_range +"/dfareporting:v3.0/Report/criteria/dimensionFilters": dimension_filters +"/dfareporting:v3.0/Report/criteria/dimensionFilters/dimension_filter": dimension_filter +"/dfareporting:v3.0/Report/criteria/dimensions": dimensions +"/dfareporting:v3.0/Report/criteria/dimensions/dimension": dimension +"/dfareporting:v3.0/Report/criteria/metricNames": metric_names +"/dfareporting:v3.0/Report/criteria/metricNames/metric_name": metric_name +"/dfareporting:v3.0/Report/crossDimensionReachCriteria": cross_dimension_reach_criteria +"/dfareporting:v3.0/Report/crossDimensionReachCriteria/breakdown": breakdown +"/dfareporting:v3.0/Report/crossDimensionReachCriteria/breakdown/breakdown": breakdown +"/dfareporting:v3.0/Report/crossDimensionReachCriteria/dateRange": date_range +"/dfareporting:v3.0/Report/crossDimensionReachCriteria/dimension": dimension +"/dfareporting:v3.0/Report/crossDimensionReachCriteria/dimensionFilters": dimension_filters +"/dfareporting:v3.0/Report/crossDimensionReachCriteria/dimensionFilters/dimension_filter": dimension_filter +"/dfareporting:v3.0/Report/crossDimensionReachCriteria/metricNames": metric_names +"/dfareporting:v3.0/Report/crossDimensionReachCriteria/metricNames/metric_name": metric_name +"/dfareporting:v3.0/Report/crossDimensionReachCriteria/overlapMetricNames": overlap_metric_names +"/dfareporting:v3.0/Report/crossDimensionReachCriteria/overlapMetricNames/overlap_metric_name": overlap_metric_name +"/dfareporting:v3.0/Report/crossDimensionReachCriteria/pivoted": pivoted +"/dfareporting:v3.0/Report/delivery": delivery +"/dfareporting:v3.0/Report/delivery/emailOwner": email_owner +"/dfareporting:v3.0/Report/delivery/emailOwnerDeliveryType": email_owner_delivery_type +"/dfareporting:v3.0/Report/delivery/message": message +"/dfareporting:v3.0/Report/delivery/recipients": recipients +"/dfareporting:v3.0/Report/delivery/recipients/recipient": recipient +"/dfareporting:v3.0/Report/etag": etag +"/dfareporting:v3.0/Report/fileName": file_name +"/dfareporting:v3.0/Report/floodlightCriteria": floodlight_criteria +"/dfareporting:v3.0/Report/floodlightCriteria/customRichMediaEvents": custom_rich_media_events +"/dfareporting:v3.0/Report/floodlightCriteria/customRichMediaEvents/custom_rich_media_event": custom_rich_media_event +"/dfareporting:v3.0/Report/floodlightCriteria/dateRange": date_range +"/dfareporting:v3.0/Report/floodlightCriteria/dimensionFilters": dimension_filters +"/dfareporting:v3.0/Report/floodlightCriteria/dimensionFilters/dimension_filter": dimension_filter +"/dfareporting:v3.0/Report/floodlightCriteria/dimensions": dimensions +"/dfareporting:v3.0/Report/floodlightCriteria/dimensions/dimension": dimension +"/dfareporting:v3.0/Report/floodlightCriteria/floodlightConfigId": floodlight_config_id +"/dfareporting:v3.0/Report/floodlightCriteria/metricNames": metric_names +"/dfareporting:v3.0/Report/floodlightCriteria/metricNames/metric_name": metric_name +"/dfareporting:v3.0/Report/floodlightCriteria/reportProperties": report_properties +"/dfareporting:v3.0/Report/floodlightCriteria/reportProperties/includeAttributedIPConversions": include_attributed_ip_conversions +"/dfareporting:v3.0/Report/floodlightCriteria/reportProperties/includeUnattributedCookieConversions": include_unattributed_cookie_conversions +"/dfareporting:v3.0/Report/floodlightCriteria/reportProperties/includeUnattributedIPConversions": include_unattributed_ip_conversions +"/dfareporting:v3.0/Report/format": format +"/dfareporting:v3.0/Report/id": id +"/dfareporting:v3.0/Report/kind": kind +"/dfareporting:v3.0/Report/lastModifiedTime": last_modified_time +"/dfareporting:v3.0/Report/name": name +"/dfareporting:v3.0/Report/ownerProfileId": owner_profile_id +"/dfareporting:v3.0/Report/pathToConversionCriteria": path_to_conversion_criteria +"/dfareporting:v3.0/Report/pathToConversionCriteria/activityFilters": activity_filters +"/dfareporting:v3.0/Report/pathToConversionCriteria/activityFilters/activity_filter": activity_filter +"/dfareporting:v3.0/Report/pathToConversionCriteria/conversionDimensions": conversion_dimensions +"/dfareporting:v3.0/Report/pathToConversionCriteria/conversionDimensions/conversion_dimension": conversion_dimension +"/dfareporting:v3.0/Report/pathToConversionCriteria/customFloodlightVariables": custom_floodlight_variables +"/dfareporting:v3.0/Report/pathToConversionCriteria/customFloodlightVariables/custom_floodlight_variable": custom_floodlight_variable +"/dfareporting:v3.0/Report/pathToConversionCriteria/customRichMediaEvents": custom_rich_media_events +"/dfareporting:v3.0/Report/pathToConversionCriteria/customRichMediaEvents/custom_rich_media_event": custom_rich_media_event +"/dfareporting:v3.0/Report/pathToConversionCriteria/dateRange": date_range +"/dfareporting:v3.0/Report/pathToConversionCriteria/floodlightConfigId": floodlight_config_id +"/dfareporting:v3.0/Report/pathToConversionCriteria/metricNames": metric_names +"/dfareporting:v3.0/Report/pathToConversionCriteria/metricNames/metric_name": metric_name +"/dfareporting:v3.0/Report/pathToConversionCriteria/perInteractionDimensions": per_interaction_dimensions +"/dfareporting:v3.0/Report/pathToConversionCriteria/perInteractionDimensions/per_interaction_dimension": per_interaction_dimension +"/dfareporting:v3.0/Report/pathToConversionCriteria/reportProperties": report_properties +"/dfareporting:v3.0/Report/pathToConversionCriteria/reportProperties/clicksLookbackWindow": clicks_lookback_window +"/dfareporting:v3.0/Report/pathToConversionCriteria/reportProperties/impressionsLookbackWindow": impressions_lookback_window +"/dfareporting:v3.0/Report/pathToConversionCriteria/reportProperties/includeAttributedIPConversions": include_attributed_ip_conversions +"/dfareporting:v3.0/Report/pathToConversionCriteria/reportProperties/includeUnattributedCookieConversions": include_unattributed_cookie_conversions +"/dfareporting:v3.0/Report/pathToConversionCriteria/reportProperties/includeUnattributedIPConversions": include_unattributed_ip_conversions +"/dfareporting:v3.0/Report/pathToConversionCriteria/reportProperties/maximumClickInteractions": maximum_click_interactions +"/dfareporting:v3.0/Report/pathToConversionCriteria/reportProperties/maximumImpressionInteractions": maximum_impression_interactions +"/dfareporting:v3.0/Report/pathToConversionCriteria/reportProperties/maximumInteractionGap": maximum_interaction_gap +"/dfareporting:v3.0/Report/pathToConversionCriteria/reportProperties/pivotOnInteractionPath": pivot_on_interaction_path +"/dfareporting:v3.0/Report/reachCriteria": reach_criteria +"/dfareporting:v3.0/Report/reachCriteria/activities": activities +"/dfareporting:v3.0/Report/reachCriteria/customRichMediaEvents": custom_rich_media_events +"/dfareporting:v3.0/Report/reachCriteria/dateRange": date_range +"/dfareporting:v3.0/Report/reachCriteria/dimensionFilters": dimension_filters +"/dfareporting:v3.0/Report/reachCriteria/dimensionFilters/dimension_filter": dimension_filter +"/dfareporting:v3.0/Report/reachCriteria/dimensions": dimensions +"/dfareporting:v3.0/Report/reachCriteria/dimensions/dimension": dimension +"/dfareporting:v3.0/Report/reachCriteria/enableAllDimensionCombinations": enable_all_dimension_combinations +"/dfareporting:v3.0/Report/reachCriteria/metricNames": metric_names +"/dfareporting:v3.0/Report/reachCriteria/metricNames/metric_name": metric_name +"/dfareporting:v3.0/Report/reachCriteria/reachByFrequencyMetricNames": reach_by_frequency_metric_names +"/dfareporting:v3.0/Report/reachCriteria/reachByFrequencyMetricNames/reach_by_frequency_metric_name": reach_by_frequency_metric_name +"/dfareporting:v3.0/Report/schedule": schedule +"/dfareporting:v3.0/Report/schedule/active": active +"/dfareporting:v3.0/Report/schedule/every": every +"/dfareporting:v3.0/Report/schedule/expirationDate": expiration_date +"/dfareporting:v3.0/Report/schedule/repeats": repeats +"/dfareporting:v3.0/Report/schedule/repeatsOnWeekDays": repeats_on_week_days +"/dfareporting:v3.0/Report/schedule/repeatsOnWeekDays/repeats_on_week_day": repeats_on_week_day +"/dfareporting:v3.0/Report/schedule/runsOnDayOfMonth": runs_on_day_of_month +"/dfareporting:v3.0/Report/schedule/startDate": start_date +"/dfareporting:v3.0/Report/subAccountId": sub_account_id +"/dfareporting:v3.0/Report/type": type +"/dfareporting:v3.0/ReportCompatibleFields": report_compatible_fields +"/dfareporting:v3.0/ReportCompatibleFields/dimensionFilters": dimension_filters +"/dfareporting:v3.0/ReportCompatibleFields/dimensionFilters/dimension_filter": dimension_filter +"/dfareporting:v3.0/ReportCompatibleFields/dimensions": dimensions +"/dfareporting:v3.0/ReportCompatibleFields/dimensions/dimension": dimension +"/dfareporting:v3.0/ReportCompatibleFields/kind": kind +"/dfareporting:v3.0/ReportCompatibleFields/metrics": metrics +"/dfareporting:v3.0/ReportCompatibleFields/metrics/metric": metric +"/dfareporting:v3.0/ReportCompatibleFields/pivotedActivityMetrics": pivoted_activity_metrics +"/dfareporting:v3.0/ReportCompatibleFields/pivotedActivityMetrics/pivoted_activity_metric": pivoted_activity_metric +"/dfareporting:v3.0/ReportList": report_list +"/dfareporting:v3.0/ReportList/etag": etag +"/dfareporting:v3.0/ReportList/items": items +"/dfareporting:v3.0/ReportList/items/item": item +"/dfareporting:v3.0/ReportList/kind": kind +"/dfareporting:v3.0/ReportList/nextPageToken": next_page_token +"/dfareporting:v3.0/ReportsConfiguration": reports_configuration +"/dfareporting:v3.0/ReportsConfiguration/exposureToConversionEnabled": exposure_to_conversion_enabled +"/dfareporting:v3.0/ReportsConfiguration/lookbackConfiguration": lookback_configuration +"/dfareporting:v3.0/ReportsConfiguration/reportGenerationTimeZoneId": report_generation_time_zone_id +"/dfareporting:v3.0/RichMediaExitOverride": rich_media_exit_override +"/dfareporting:v3.0/RichMediaExitOverride/clickThroughUrl": click_through_url +"/dfareporting:v3.0/RichMediaExitOverride/enabled": enabled +"/dfareporting:v3.0/RichMediaExitOverride/exitId": exit_id +"/dfareporting:v3.0/Rule": rule +"/dfareporting:v3.0/Rule/assetId": asset_id +"/dfareporting:v3.0/Rule/name": name +"/dfareporting:v3.0/Rule/targetingTemplateId": targeting_template_id +"/dfareporting:v3.0/Site": site +"/dfareporting:v3.0/Site/accountId": account_id +"/dfareporting:v3.0/Site/approved": approved +"/dfareporting:v3.0/Site/directorySiteId": directory_site_id +"/dfareporting:v3.0/Site/directorySiteIdDimensionValue": directory_site_id_dimension_value +"/dfareporting:v3.0/Site/id": id +"/dfareporting:v3.0/Site/idDimensionValue": id_dimension_value +"/dfareporting:v3.0/Site/keyName": key_name +"/dfareporting:v3.0/Site/kind": kind +"/dfareporting:v3.0/Site/name": name +"/dfareporting:v3.0/Site/siteContacts": site_contacts +"/dfareporting:v3.0/Site/siteContacts/site_contact": site_contact +"/dfareporting:v3.0/Site/siteSettings": site_settings +"/dfareporting:v3.0/Site/subaccountId": subaccount_id +"/dfareporting:v3.0/SiteContact": site_contact +"/dfareporting:v3.0/SiteContact/address": address +"/dfareporting:v3.0/SiteContact/contactType": contact_type +"/dfareporting:v3.0/SiteContact/email": email +"/dfareporting:v3.0/SiteContact/firstName": first_name +"/dfareporting:v3.0/SiteContact/id": id +"/dfareporting:v3.0/SiteContact/lastName": last_name +"/dfareporting:v3.0/SiteContact/phone": phone +"/dfareporting:v3.0/SiteContact/title": title +"/dfareporting:v3.0/SiteSettings": site_settings +"/dfareporting:v3.0/SiteSettings/activeViewOptOut": active_view_opt_out +"/dfareporting:v3.0/SiteSettings/adBlockingOptOut": ad_blocking_opt_out +"/dfareporting:v3.0/SiteSettings/creativeSettings": creative_settings +"/dfareporting:v3.0/SiteSettings/disableNewCookie": disable_new_cookie +"/dfareporting:v3.0/SiteSettings/lookbackConfiguration": lookback_configuration +"/dfareporting:v3.0/SiteSettings/tagSetting": tag_setting +"/dfareporting:v3.0/SiteSettings/videoActiveViewOptOutTemplate": video_active_view_opt_out_template +"/dfareporting:v3.0/SiteSettings/vpaidAdapterChoiceTemplate": vpaid_adapter_choice_template +"/dfareporting:v3.0/SitesListResponse": sites_list_response +"/dfareporting:v3.0/SitesListResponse/kind": kind +"/dfareporting:v3.0/SitesListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/SitesListResponse/sites": sites +"/dfareporting:v3.0/SitesListResponse/sites/site": site +"/dfareporting:v3.0/Size": size +"/dfareporting:v3.0/Size/height": height +"/dfareporting:v3.0/Size/iab": iab +"/dfareporting:v3.0/Size/id": id +"/dfareporting:v3.0/Size/kind": kind +"/dfareporting:v3.0/Size/width": width +"/dfareporting:v3.0/SizesListResponse": sizes_list_response +"/dfareporting:v3.0/SizesListResponse/kind": kind +"/dfareporting:v3.0/SizesListResponse/sizes": sizes +"/dfareporting:v3.0/SizesListResponse/sizes/size": size +"/dfareporting:v3.0/SkippableSetting": skippable_setting +"/dfareporting:v3.0/SkippableSetting/kind": kind +"/dfareporting:v3.0/SkippableSetting/progressOffset": progress_offset +"/dfareporting:v3.0/SkippableSetting/skipOffset": skip_offset +"/dfareporting:v3.0/SkippableSetting/skippable": skippable +"/dfareporting:v3.0/SortedDimension": sorted_dimension +"/dfareporting:v3.0/SortedDimension/kind": kind +"/dfareporting:v3.0/SortedDimension/name": name +"/dfareporting:v3.0/SortedDimension/sortOrder": sort_order +"/dfareporting:v3.0/Subaccount": subaccount +"/dfareporting:v3.0/Subaccount/accountId": account_id +"/dfareporting:v3.0/Subaccount/availablePermissionIds": available_permission_ids +"/dfareporting:v3.0/Subaccount/availablePermissionIds/available_permission_id": available_permission_id +"/dfareporting:v3.0/Subaccount/id": id +"/dfareporting:v3.0/Subaccount/kind": kind +"/dfareporting:v3.0/Subaccount/name": name +"/dfareporting:v3.0/SubaccountsListResponse": subaccounts_list_response +"/dfareporting:v3.0/SubaccountsListResponse/kind": kind +"/dfareporting:v3.0/SubaccountsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/SubaccountsListResponse/subaccounts": subaccounts +"/dfareporting:v3.0/SubaccountsListResponse/subaccounts/subaccount": subaccount +"/dfareporting:v3.0/TagData": tag_data +"/dfareporting:v3.0/TagData/adId": ad_id +"/dfareporting:v3.0/TagData/clickTag": click_tag +"/dfareporting:v3.0/TagData/creativeId": creative_id +"/dfareporting:v3.0/TagData/format": format +"/dfareporting:v3.0/TagData/impressionTag": impression_tag +"/dfareporting:v3.0/TagSetting": tag_setting +"/dfareporting:v3.0/TagSetting/additionalKeyValues": additional_key_values +"/dfareporting:v3.0/TagSetting/includeClickThroughUrls": include_click_through_urls +"/dfareporting:v3.0/TagSetting/includeClickTracking": include_click_tracking +"/dfareporting:v3.0/TagSetting/keywordOption": keyword_option +"/dfareporting:v3.0/TagSettings": tag_settings +"/dfareporting:v3.0/TagSettings/dynamicTagEnabled": dynamic_tag_enabled +"/dfareporting:v3.0/TagSettings/imageTagEnabled": image_tag_enabled +"/dfareporting:v3.0/TargetWindow": target_window +"/dfareporting:v3.0/TargetWindow/customHtml": custom_html +"/dfareporting:v3.0/TargetWindow/targetWindowOption": target_window_option +"/dfareporting:v3.0/TargetableRemarketingList": targetable_remarketing_list +"/dfareporting:v3.0/TargetableRemarketingList/accountId": account_id +"/dfareporting:v3.0/TargetableRemarketingList/active": active +"/dfareporting:v3.0/TargetableRemarketingList/advertiserId": advertiser_id +"/dfareporting:v3.0/TargetableRemarketingList/advertiserIdDimensionValue": advertiser_id_dimension_value +"/dfareporting:v3.0/TargetableRemarketingList/description": description +"/dfareporting:v3.0/TargetableRemarketingList/id": id +"/dfareporting:v3.0/TargetableRemarketingList/kind": kind +"/dfareporting:v3.0/TargetableRemarketingList/lifeSpan": life_span +"/dfareporting:v3.0/TargetableRemarketingList/listSize": list_size +"/dfareporting:v3.0/TargetableRemarketingList/listSource": list_source +"/dfareporting:v3.0/TargetableRemarketingList/name": name +"/dfareporting:v3.0/TargetableRemarketingList/subaccountId": subaccount_id +"/dfareporting:v3.0/TargetableRemarketingListsListResponse": targetable_remarketing_lists_list_response +"/dfareporting:v3.0/TargetableRemarketingListsListResponse/kind": kind +"/dfareporting:v3.0/TargetableRemarketingListsListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/TargetableRemarketingListsListResponse/targetableRemarketingLists": targetable_remarketing_lists +"/dfareporting:v3.0/TargetableRemarketingListsListResponse/targetableRemarketingLists/targetable_remarketing_list": targetable_remarketing_list +"/dfareporting:v3.0/TargetingTemplate": targeting_template +"/dfareporting:v3.0/TargetingTemplate/accountId": account_id +"/dfareporting:v3.0/TargetingTemplate/advertiserId": advertiser_id +"/dfareporting:v3.0/TargetingTemplate/advertiserIdDimensionValue": advertiser_id_dimension_value +"/dfareporting:v3.0/TargetingTemplate/dayPartTargeting": day_part_targeting +"/dfareporting:v3.0/TargetingTemplate/geoTargeting": geo_targeting +"/dfareporting:v3.0/TargetingTemplate/id": id +"/dfareporting:v3.0/TargetingTemplate/keyValueTargetingExpression": key_value_targeting_expression +"/dfareporting:v3.0/TargetingTemplate/kind": kind +"/dfareporting:v3.0/TargetingTemplate/languageTargeting": language_targeting +"/dfareporting:v3.0/TargetingTemplate/listTargetingExpression": list_targeting_expression +"/dfareporting:v3.0/TargetingTemplate/name": name +"/dfareporting:v3.0/TargetingTemplate/subaccountId": subaccount_id +"/dfareporting:v3.0/TargetingTemplate/technologyTargeting": technology_targeting +"/dfareporting:v3.0/TargetingTemplatesListResponse": targeting_templates_list_response +"/dfareporting:v3.0/TargetingTemplatesListResponse/kind": kind +"/dfareporting:v3.0/TargetingTemplatesListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/TargetingTemplatesListResponse/targetingTemplates": targeting_templates +"/dfareporting:v3.0/TargetingTemplatesListResponse/targetingTemplates/targeting_template": targeting_template +"/dfareporting:v3.0/TechnologyTargeting": technology_targeting +"/dfareporting:v3.0/TechnologyTargeting/browsers": browsers +"/dfareporting:v3.0/TechnologyTargeting/browsers/browser": browser +"/dfareporting:v3.0/TechnologyTargeting/connectionTypes": connection_types +"/dfareporting:v3.0/TechnologyTargeting/connectionTypes/connection_type": connection_type +"/dfareporting:v3.0/TechnologyTargeting/mobileCarriers": mobile_carriers +"/dfareporting:v3.0/TechnologyTargeting/mobileCarriers/mobile_carrier": mobile_carrier +"/dfareporting:v3.0/TechnologyTargeting/operatingSystemVersions": operating_system_versions +"/dfareporting:v3.0/TechnologyTargeting/operatingSystemVersions/operating_system_version": operating_system_version +"/dfareporting:v3.0/TechnologyTargeting/operatingSystems": operating_systems +"/dfareporting:v3.0/TechnologyTargeting/operatingSystems/operating_system": operating_system +"/dfareporting:v3.0/TechnologyTargeting/platformTypes": platform_types +"/dfareporting:v3.0/TechnologyTargeting/platformTypes/platform_type": platform_type +"/dfareporting:v3.0/ThirdPartyAuthenticationToken": third_party_authentication_token +"/dfareporting:v3.0/ThirdPartyAuthenticationToken/name": name +"/dfareporting:v3.0/ThirdPartyAuthenticationToken/value": value +"/dfareporting:v3.0/ThirdPartyTrackingUrl": third_party_tracking_url +"/dfareporting:v3.0/ThirdPartyTrackingUrl/thirdPartyUrlType": third_party_url_type +"/dfareporting:v3.0/ThirdPartyTrackingUrl/url": url +"/dfareporting:v3.0/TranscodeSetting": transcode_setting +"/dfareporting:v3.0/TranscodeSetting/enabledVideoFormats": enabled_video_formats +"/dfareporting:v3.0/TranscodeSetting/enabledVideoFormats/enabled_video_format": enabled_video_format +"/dfareporting:v3.0/TranscodeSetting/kind": kind +"/dfareporting:v3.0/UniversalAdId": universal_ad_id +"/dfareporting:v3.0/UniversalAdId/registry": registry +"/dfareporting:v3.0/UniversalAdId/value": value +"/dfareporting:v3.0/UserDefinedVariableConfiguration": user_defined_variable_configuration +"/dfareporting:v3.0/UserDefinedVariableConfiguration/dataType": data_type +"/dfareporting:v3.0/UserDefinedVariableConfiguration/reportName": report_name +"/dfareporting:v3.0/UserDefinedVariableConfiguration/variableType": variable_type +"/dfareporting:v3.0/UserProfile": user_profile +"/dfareporting:v3.0/UserProfile/accountId": account_id +"/dfareporting:v3.0/UserProfile/accountName": account_name +"/dfareporting:v3.0/UserProfile/etag": etag +"/dfareporting:v3.0/UserProfile/kind": kind +"/dfareporting:v3.0/UserProfile/profileId": profile_id +"/dfareporting:v3.0/UserProfile/subAccountId": sub_account_id +"/dfareporting:v3.0/UserProfile/subAccountName": sub_account_name +"/dfareporting:v3.0/UserProfile/userName": user_name +"/dfareporting:v3.0/UserProfileList": user_profile_list +"/dfareporting:v3.0/UserProfileList/etag": etag +"/dfareporting:v3.0/UserProfileList/items": items +"/dfareporting:v3.0/UserProfileList/items/item": item +"/dfareporting:v3.0/UserProfileList/kind": kind +"/dfareporting:v3.0/UserRole": user_role +"/dfareporting:v3.0/UserRole/accountId": account_id +"/dfareporting:v3.0/UserRole/defaultUserRole": default_user_role +"/dfareporting:v3.0/UserRole/id": id +"/dfareporting:v3.0/UserRole/kind": kind +"/dfareporting:v3.0/UserRole/name": name +"/dfareporting:v3.0/UserRole/parentUserRoleId": parent_user_role_id +"/dfareporting:v3.0/UserRole/permissions": permissions +"/dfareporting:v3.0/UserRole/permissions/permission": permission +"/dfareporting:v3.0/UserRole/subaccountId": subaccount_id +"/dfareporting:v3.0/UserRolePermission": user_role_permission +"/dfareporting:v3.0/UserRolePermission/availability": availability +"/dfareporting:v3.0/UserRolePermission/id": id +"/dfareporting:v3.0/UserRolePermission/kind": kind +"/dfareporting:v3.0/UserRolePermission/name": name +"/dfareporting:v3.0/UserRolePermission/permissionGroupId": permission_group_id +"/dfareporting:v3.0/UserRolePermissionGroup": user_role_permission_group +"/dfareporting:v3.0/UserRolePermissionGroup/id": id +"/dfareporting:v3.0/UserRolePermissionGroup/kind": kind +"/dfareporting:v3.0/UserRolePermissionGroup/name": name +"/dfareporting:v3.0/UserRolePermissionGroupsListResponse": user_role_permission_groups_list_response +"/dfareporting:v3.0/UserRolePermissionGroupsListResponse/kind": kind +"/dfareporting:v3.0/UserRolePermissionGroupsListResponse/userRolePermissionGroups": user_role_permission_groups +"/dfareporting:v3.0/UserRolePermissionGroupsListResponse/userRolePermissionGroups/user_role_permission_group": user_role_permission_group +"/dfareporting:v3.0/UserRolePermissionsListResponse": user_role_permissions_list_response +"/dfareporting:v3.0/UserRolePermissionsListResponse/kind": kind +"/dfareporting:v3.0/UserRolePermissionsListResponse/userRolePermissions": user_role_permissions +"/dfareporting:v3.0/UserRolePermissionsListResponse/userRolePermissions/user_role_permission": user_role_permission +"/dfareporting:v3.0/UserRolesListResponse": user_roles_list_response +"/dfareporting:v3.0/UserRolesListResponse/kind": kind +"/dfareporting:v3.0/UserRolesListResponse/nextPageToken": next_page_token +"/dfareporting:v3.0/UserRolesListResponse/userRoles": user_roles +"/dfareporting:v3.0/UserRolesListResponse/userRoles/user_role": user_role +"/dfareporting:v3.0/VideoFormat": video_format +"/dfareporting:v3.0/VideoFormat/fileType": file_type +"/dfareporting:v3.0/VideoFormat/id": id +"/dfareporting:v3.0/VideoFormat/kind": kind +"/dfareporting:v3.0/VideoFormat/resolution": resolution +"/dfareporting:v3.0/VideoFormat/targetBitRate": target_bit_rate +"/dfareporting:v3.0/VideoFormatsListResponse": video_formats_list_response +"/dfareporting:v3.0/VideoFormatsListResponse/kind": kind +"/dfareporting:v3.0/VideoFormatsListResponse/videoFormats": video_formats +"/dfareporting:v3.0/VideoFormatsListResponse/videoFormats/video_format": video_format +"/dfareporting:v3.0/VideoOffset": video_offset +"/dfareporting:v3.0/VideoOffset/offsetPercentage": offset_percentage +"/dfareporting:v3.0/VideoOffset/offsetSeconds": offset_seconds +"/dfareporting:v3.0/VideoSettings": video_settings +"/dfareporting:v3.0/VideoSettings/companionSettings": companion_settings +"/dfareporting:v3.0/VideoSettings/kind": kind +"/dfareporting:v3.0/VideoSettings/orientation": orientation +"/dfareporting:v3.0/VideoSettings/skippableSettings": skippable_settings +"/dfareporting:v3.0/VideoSettings/transcodeSettings": transcode_settings +"/dfareporting:v3.0/dfareporting.accountActiveAdSummaries.get": get_account_active_ad_summary +"/dfareporting:v3.0/dfareporting.accountActiveAdSummaries.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.accountActiveAdSummaries.get/summaryAccountId": summary_account_id +"/dfareporting:v3.0/dfareporting.accountPermissionGroups.get": get_account_permission_group +"/dfareporting:v3.0/dfareporting.accountPermissionGroups.get/id": id +"/dfareporting:v3.0/dfareporting.accountPermissionGroups.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.accountPermissionGroups.list": list_account_permission_groups +"/dfareporting:v3.0/dfareporting.accountPermissionGroups.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.accountPermissions.get": get_account_permission +"/dfareporting:v3.0/dfareporting.accountPermissions.get/id": id +"/dfareporting:v3.0/dfareporting.accountPermissions.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.accountPermissions.list": list_account_permissions +"/dfareporting:v3.0/dfareporting.accountPermissions.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.accountUserProfiles.get": get_account_user_profile +"/dfareporting:v3.0/dfareporting.accountUserProfiles.get/id": id +"/dfareporting:v3.0/dfareporting.accountUserProfiles.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.accountUserProfiles.insert": insert_account_user_profile +"/dfareporting:v3.0/dfareporting.accountUserProfiles.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.accountUserProfiles.list": list_account_user_profiles +"/dfareporting:v3.0/dfareporting.accountUserProfiles.list/active": active +"/dfareporting:v3.0/dfareporting.accountUserProfiles.list/ids": ids +"/dfareporting:v3.0/dfareporting.accountUserProfiles.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.accountUserProfiles.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.accountUserProfiles.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.accountUserProfiles.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.accountUserProfiles.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.accountUserProfiles.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.accountUserProfiles.list/subaccountId": subaccount_id +"/dfareporting:v3.0/dfareporting.accountUserProfiles.list/userRoleId": user_role_id +"/dfareporting:v3.0/dfareporting.accountUserProfiles.patch": patch_account_user_profile +"/dfareporting:v3.0/dfareporting.accountUserProfiles.patch/id": id +"/dfareporting:v3.0/dfareporting.accountUserProfiles.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.accountUserProfiles.update": update_account_user_profile +"/dfareporting:v3.0/dfareporting.accountUserProfiles.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.accounts.get": get_account +"/dfareporting:v3.0/dfareporting.accounts.get/id": id +"/dfareporting:v3.0/dfareporting.accounts.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.accounts.list": list_accounts +"/dfareporting:v3.0/dfareporting.accounts.list/active": active +"/dfareporting:v3.0/dfareporting.accounts.list/ids": ids +"/dfareporting:v3.0/dfareporting.accounts.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.accounts.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.accounts.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.accounts.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.accounts.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.accounts.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.accounts.patch": patch_account +"/dfareporting:v3.0/dfareporting.accounts.patch/id": id +"/dfareporting:v3.0/dfareporting.accounts.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.accounts.update": update_account +"/dfareporting:v3.0/dfareporting.accounts.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.ads.get": get_ad +"/dfareporting:v3.0/dfareporting.ads.get/id": id +"/dfareporting:v3.0/dfareporting.ads.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.ads.insert": insert_ad +"/dfareporting:v3.0/dfareporting.ads.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.ads.list": list_ads +"/dfareporting:v3.0/dfareporting.ads.list/active": active +"/dfareporting:v3.0/dfareporting.ads.list/advertiserId": advertiser_id +"/dfareporting:v3.0/dfareporting.ads.list/archived": archived +"/dfareporting:v3.0/dfareporting.ads.list/audienceSegmentIds": audience_segment_ids +"/dfareporting:v3.0/dfareporting.ads.list/campaignIds": campaign_ids +"/dfareporting:v3.0/dfareporting.ads.list/compatibility": compatibility +"/dfareporting:v3.0/dfareporting.ads.list/creativeIds": creative_ids +"/dfareporting:v3.0/dfareporting.ads.list/creativeOptimizationConfigurationIds": creative_optimization_configuration_ids +"/dfareporting:v3.0/dfareporting.ads.list/dynamicClickTracker": dynamic_click_tracker +"/dfareporting:v3.0/dfareporting.ads.list/ids": ids +"/dfareporting:v3.0/dfareporting.ads.list/landingPageIds": landing_page_ids +"/dfareporting:v3.0/dfareporting.ads.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.ads.list/overriddenEventTagId": overridden_event_tag_id +"/dfareporting:v3.0/dfareporting.ads.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.ads.list/placementIds": placement_ids +"/dfareporting:v3.0/dfareporting.ads.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.ads.list/remarketingListIds": remarketing_list_ids +"/dfareporting:v3.0/dfareporting.ads.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.ads.list/sizeIds": size_ids +"/dfareporting:v3.0/dfareporting.ads.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.ads.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.ads.list/sslCompliant": ssl_compliant +"/dfareporting:v3.0/dfareporting.ads.list/sslRequired": ssl_required +"/dfareporting:v3.0/dfareporting.ads.list/type": type +"/dfareporting:v3.0/dfareporting.ads.patch": patch_ad +"/dfareporting:v3.0/dfareporting.ads.patch/id": id +"/dfareporting:v3.0/dfareporting.ads.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.ads.update": update_ad +"/dfareporting:v3.0/dfareporting.ads.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertiserGroups.delete": delete_advertiser_group +"/dfareporting:v3.0/dfareporting.advertiserGroups.delete/id": id +"/dfareporting:v3.0/dfareporting.advertiserGroups.delete/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertiserGroups.get": get_advertiser_group +"/dfareporting:v3.0/dfareporting.advertiserGroups.get/id": id +"/dfareporting:v3.0/dfareporting.advertiserGroups.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertiserGroups.insert": insert_advertiser_group +"/dfareporting:v3.0/dfareporting.advertiserGroups.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertiserGroups.list": list_advertiser_groups +"/dfareporting:v3.0/dfareporting.advertiserGroups.list/ids": ids +"/dfareporting:v3.0/dfareporting.advertiserGroups.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.advertiserGroups.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.advertiserGroups.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertiserGroups.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.advertiserGroups.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.advertiserGroups.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.advertiserGroups.patch": patch_advertiser_group +"/dfareporting:v3.0/dfareporting.advertiserGroups.patch/id": id +"/dfareporting:v3.0/dfareporting.advertiserGroups.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertiserGroups.update": update_advertiser_group +"/dfareporting:v3.0/dfareporting.advertiserGroups.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.get": get_advertiser_landing_page +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.get/id": id +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.insert": insert_advertiser_landing_page +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.list": list_advertiser_landing_pages +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.list/advertiserIds": advertiser_ids +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.list/archived": archived +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.list/ids": ids +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.list/subaccountId": subaccount_id +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.patch": patch_advertiser_landing_page +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.patch/id": id +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.update": update_advertiser_landing_page +"/dfareporting:v3.0/dfareporting.advertiserLandingPages.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertisers.get": get_advertiser +"/dfareporting:v3.0/dfareporting.advertisers.get/id": id +"/dfareporting:v3.0/dfareporting.advertisers.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertisers.insert": insert_advertiser +"/dfareporting:v3.0/dfareporting.advertisers.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertisers.list": list_advertisers +"/dfareporting:v3.0/dfareporting.advertisers.list/advertiserGroupIds": advertiser_group_ids +"/dfareporting:v3.0/dfareporting.advertisers.list/floodlightConfigurationIds": floodlight_configuration_ids +"/dfareporting:v3.0/dfareporting.advertisers.list/ids": ids +"/dfareporting:v3.0/dfareporting.advertisers.list/includeAdvertisersWithoutGroupsOnly": include_advertisers_without_groups_only +"/dfareporting:v3.0/dfareporting.advertisers.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.advertisers.list/onlyParent": only_parent +"/dfareporting:v3.0/dfareporting.advertisers.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.advertisers.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertisers.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.advertisers.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.advertisers.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.advertisers.list/status": status +"/dfareporting:v3.0/dfareporting.advertisers.list/subaccountId": subaccount_id +"/dfareporting:v3.0/dfareporting.advertisers.patch": patch_advertiser +"/dfareporting:v3.0/dfareporting.advertisers.patch/id": id +"/dfareporting:v3.0/dfareporting.advertisers.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.advertisers.update": update_advertiser +"/dfareporting:v3.0/dfareporting.advertisers.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.browsers.list": list_browsers +"/dfareporting:v3.0/dfareporting.browsers.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.campaignCreativeAssociations.insert": insert_campaign_creative_association +"/dfareporting:v3.0/dfareporting.campaignCreativeAssociations.insert/campaignId": campaign_id +"/dfareporting:v3.0/dfareporting.campaignCreativeAssociations.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.campaignCreativeAssociations.list": list_campaign_creative_associations +"/dfareporting:v3.0/dfareporting.campaignCreativeAssociations.list/campaignId": campaign_id +"/dfareporting:v3.0/dfareporting.campaignCreativeAssociations.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.campaignCreativeAssociations.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.campaignCreativeAssociations.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.campaignCreativeAssociations.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.campaigns.get": get_campaign +"/dfareporting:v3.0/dfareporting.campaigns.get/id": id +"/dfareporting:v3.0/dfareporting.campaigns.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.campaigns.insert": insert_campaign +"/dfareporting:v3.0/dfareporting.campaigns.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.campaigns.list": list_campaigns +"/dfareporting:v3.0/dfareporting.campaigns.list/advertiserGroupIds": advertiser_group_ids +"/dfareporting:v3.0/dfareporting.campaigns.list/advertiserIds": advertiser_ids +"/dfareporting:v3.0/dfareporting.campaigns.list/archived": archived +"/dfareporting:v3.0/dfareporting.campaigns.list/atLeastOneOptimizationActivity": at_least_one_optimization_activity +"/dfareporting:v3.0/dfareporting.campaigns.list/excludedIds": excluded_ids +"/dfareporting:v3.0/dfareporting.campaigns.list/ids": ids +"/dfareporting:v3.0/dfareporting.campaigns.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.campaigns.list/overriddenEventTagId": overridden_event_tag_id +"/dfareporting:v3.0/dfareporting.campaigns.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.campaigns.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.campaigns.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.campaigns.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.campaigns.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.campaigns.list/subaccountId": subaccount_id +"/dfareporting:v3.0/dfareporting.campaigns.patch": patch_campaign +"/dfareporting:v3.0/dfareporting.campaigns.patch/id": id +"/dfareporting:v3.0/dfareporting.campaigns.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.campaigns.update": update_campaign +"/dfareporting:v3.0/dfareporting.campaigns.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.changeLogs.get": get_change_log +"/dfareporting:v3.0/dfareporting.changeLogs.get/id": id +"/dfareporting:v3.0/dfareporting.changeLogs.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.changeLogs.list": list_change_logs +"/dfareporting:v3.0/dfareporting.changeLogs.list/action": action +"/dfareporting:v3.0/dfareporting.changeLogs.list/ids": ids +"/dfareporting:v3.0/dfareporting.changeLogs.list/maxChangeTime": max_change_time +"/dfareporting:v3.0/dfareporting.changeLogs.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.changeLogs.list/minChangeTime": min_change_time +"/dfareporting:v3.0/dfareporting.changeLogs.list/objectIds": object_ids +"/dfareporting:v3.0/dfareporting.changeLogs.list/objectType": object_type +"/dfareporting:v3.0/dfareporting.changeLogs.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.changeLogs.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.changeLogs.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.changeLogs.list/userProfileIds": user_profile_ids +"/dfareporting:v3.0/dfareporting.cities.list": list_cities +"/dfareporting:v3.0/dfareporting.cities.list/countryDartIds": country_dart_ids +"/dfareporting:v3.0/dfareporting.cities.list/dartIds": dart_ids +"/dfareporting:v3.0/dfareporting.cities.list/namePrefix": name_prefix +"/dfareporting:v3.0/dfareporting.cities.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.cities.list/regionDartIds": region_dart_ids +"/dfareporting:v3.0/dfareporting.connectionTypes.get": get_connection_type +"/dfareporting:v3.0/dfareporting.connectionTypes.get/id": id +"/dfareporting:v3.0/dfareporting.connectionTypes.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.connectionTypes.list": list_connection_types +"/dfareporting:v3.0/dfareporting.connectionTypes.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.contentCategories.delete": delete_content_category +"/dfareporting:v3.0/dfareporting.contentCategories.delete/id": id +"/dfareporting:v3.0/dfareporting.contentCategories.delete/profileId": profile_id +"/dfareporting:v3.0/dfareporting.contentCategories.get": get_content_category +"/dfareporting:v3.0/dfareporting.contentCategories.get/id": id +"/dfareporting:v3.0/dfareporting.contentCategories.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.contentCategories.insert": insert_content_category +"/dfareporting:v3.0/dfareporting.contentCategories.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.contentCategories.list": list_content_categories +"/dfareporting:v3.0/dfareporting.contentCategories.list/ids": ids +"/dfareporting:v3.0/dfareporting.contentCategories.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.contentCategories.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.contentCategories.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.contentCategories.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.contentCategories.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.contentCategories.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.contentCategories.patch": patch_content_category +"/dfareporting:v3.0/dfareporting.contentCategories.patch/id": id +"/dfareporting:v3.0/dfareporting.contentCategories.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.contentCategories.update": update_content_category +"/dfareporting:v3.0/dfareporting.contentCategories.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.conversions.batchinsert": batchinsert_conversion +"/dfareporting:v3.0/dfareporting.conversions.batchinsert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.conversions.batchupdate": batchupdate_conversion +"/dfareporting:v3.0/dfareporting.conversions.batchupdate/profileId": profile_id +"/dfareporting:v3.0/dfareporting.countries.get": get_country +"/dfareporting:v3.0/dfareporting.countries.get/dartId": dart_id +"/dfareporting:v3.0/dfareporting.countries.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.countries.list": list_countries +"/dfareporting:v3.0/dfareporting.countries.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeAssets.insert": insert_creative_asset +"/dfareporting:v3.0/dfareporting.creativeAssets.insert/advertiserId": advertiser_id +"/dfareporting:v3.0/dfareporting.creativeAssets.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.delete": delete_creative_field_value +"/dfareporting:v3.0/dfareporting.creativeFieldValues.delete/creativeFieldId": creative_field_id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.delete/id": id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.delete/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.get": get_creative_field_value +"/dfareporting:v3.0/dfareporting.creativeFieldValues.get/creativeFieldId": creative_field_id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.get/id": id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.insert": insert_creative_field_value +"/dfareporting:v3.0/dfareporting.creativeFieldValues.insert/creativeFieldId": creative_field_id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.list": list_creative_field_values +"/dfareporting:v3.0/dfareporting.creativeFieldValues.list/creativeFieldId": creative_field_id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.list/ids": ids +"/dfareporting:v3.0/dfareporting.creativeFieldValues.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.creativeFieldValues.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.creativeFieldValues.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.creativeFieldValues.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.creativeFieldValues.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.creativeFieldValues.patch": patch_creative_field_value +"/dfareporting:v3.0/dfareporting.creativeFieldValues.patch/creativeFieldId": creative_field_id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.patch/id": id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.update": update_creative_field_value +"/dfareporting:v3.0/dfareporting.creativeFieldValues.update/creativeFieldId": creative_field_id +"/dfareporting:v3.0/dfareporting.creativeFieldValues.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeFields.delete": delete_creative_field +"/dfareporting:v3.0/dfareporting.creativeFields.delete/id": id +"/dfareporting:v3.0/dfareporting.creativeFields.delete/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeFields.get": get_creative_field +"/dfareporting:v3.0/dfareporting.creativeFields.get/id": id +"/dfareporting:v3.0/dfareporting.creativeFields.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeFields.insert": insert_creative_field +"/dfareporting:v3.0/dfareporting.creativeFields.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeFields.list": list_creative_fields +"/dfareporting:v3.0/dfareporting.creativeFields.list/advertiserIds": advertiser_ids +"/dfareporting:v3.0/dfareporting.creativeFields.list/ids": ids +"/dfareporting:v3.0/dfareporting.creativeFields.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.creativeFields.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.creativeFields.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeFields.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.creativeFields.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.creativeFields.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.creativeFields.patch": patch_creative_field +"/dfareporting:v3.0/dfareporting.creativeFields.patch/id": id +"/dfareporting:v3.0/dfareporting.creativeFields.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeFields.update": update_creative_field +"/dfareporting:v3.0/dfareporting.creativeFields.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeGroups.get": get_creative_group +"/dfareporting:v3.0/dfareporting.creativeGroups.get/id": id +"/dfareporting:v3.0/dfareporting.creativeGroups.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeGroups.insert": insert_creative_group +"/dfareporting:v3.0/dfareporting.creativeGroups.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeGroups.list": list_creative_groups +"/dfareporting:v3.0/dfareporting.creativeGroups.list/advertiserIds": advertiser_ids +"/dfareporting:v3.0/dfareporting.creativeGroups.list/groupNumber": group_number +"/dfareporting:v3.0/dfareporting.creativeGroups.list/ids": ids +"/dfareporting:v3.0/dfareporting.creativeGroups.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.creativeGroups.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.creativeGroups.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeGroups.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.creativeGroups.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.creativeGroups.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.creativeGroups.patch": patch_creative_group +"/dfareporting:v3.0/dfareporting.creativeGroups.patch/id": id +"/dfareporting:v3.0/dfareporting.creativeGroups.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creativeGroups.update": update_creative_group +"/dfareporting:v3.0/dfareporting.creativeGroups.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creatives.get": get_creative +"/dfareporting:v3.0/dfareporting.creatives.get/id": id +"/dfareporting:v3.0/dfareporting.creatives.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creatives.insert": insert_creative +"/dfareporting:v3.0/dfareporting.creatives.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creatives.list": list_creatives +"/dfareporting:v3.0/dfareporting.creatives.list/active": active +"/dfareporting:v3.0/dfareporting.creatives.list/advertiserId": advertiser_id +"/dfareporting:v3.0/dfareporting.creatives.list/archived": archived +"/dfareporting:v3.0/dfareporting.creatives.list/campaignId": campaign_id +"/dfareporting:v3.0/dfareporting.creatives.list/companionCreativeIds": companion_creative_ids +"/dfareporting:v3.0/dfareporting.creatives.list/creativeFieldIds": creative_field_ids +"/dfareporting:v3.0/dfareporting.creatives.list/ids": ids +"/dfareporting:v3.0/dfareporting.creatives.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.creatives.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.creatives.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creatives.list/renderingIds": rendering_ids +"/dfareporting:v3.0/dfareporting.creatives.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.creatives.list/sizeIds": size_ids +"/dfareporting:v3.0/dfareporting.creatives.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.creatives.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.creatives.list/studioCreativeId": studio_creative_id +"/dfareporting:v3.0/dfareporting.creatives.list/types": types +"/dfareporting:v3.0/dfareporting.creatives.patch": patch_creative +"/dfareporting:v3.0/dfareporting.creatives.patch/id": id +"/dfareporting:v3.0/dfareporting.creatives.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.creatives.update": update_creative +"/dfareporting:v3.0/dfareporting.creatives.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.dimensionValues.query": query_dimension_value +"/dfareporting:v3.0/dfareporting.dimensionValues.query/maxResults": max_results +"/dfareporting:v3.0/dfareporting.dimensionValues.query/pageToken": page_token +"/dfareporting:v3.0/dfareporting.dimensionValues.query/profileId": profile_id +"/dfareporting:v3.0/dfareporting.directorySiteContacts.get": get_directory_site_contact +"/dfareporting:v3.0/dfareporting.directorySiteContacts.get/id": id +"/dfareporting:v3.0/dfareporting.directorySiteContacts.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.directorySiteContacts.list": list_directory_site_contacts +"/dfareporting:v3.0/dfareporting.directorySiteContacts.list/directorySiteIds": directory_site_ids +"/dfareporting:v3.0/dfareporting.directorySiteContacts.list/ids": ids +"/dfareporting:v3.0/dfareporting.directorySiteContacts.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.directorySiteContacts.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.directorySiteContacts.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.directorySiteContacts.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.directorySiteContacts.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.directorySiteContacts.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.directorySites.get": get_directory_site +"/dfareporting:v3.0/dfareporting.directorySites.get/id": id +"/dfareporting:v3.0/dfareporting.directorySites.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.directorySites.insert": insert_directory_site +"/dfareporting:v3.0/dfareporting.directorySites.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.directorySites.list": list_directory_sites +"/dfareporting:v3.0/dfareporting.directorySites.list/acceptsInStreamVideoPlacements": accepts_in_stream_video_placements +"/dfareporting:v3.0/dfareporting.directorySites.list/acceptsInterstitialPlacements": accepts_interstitial_placements +"/dfareporting:v3.0/dfareporting.directorySites.list/acceptsPublisherPaidPlacements": accepts_publisher_paid_placements +"/dfareporting:v3.0/dfareporting.directorySites.list/active": active +"/dfareporting:v3.0/dfareporting.directorySites.list/countryId": country_id +"/dfareporting:v3.0/dfareporting.directorySites.list/dfpNetworkCode": dfp_network_code +"/dfareporting:v3.0/dfareporting.directorySites.list/ids": ids +"/dfareporting:v3.0/dfareporting.directorySites.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.directorySites.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.directorySites.list/parentId": parent_id +"/dfareporting:v3.0/dfareporting.directorySites.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.directorySites.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.directorySites.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.directorySites.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.dynamicTargetingKeys.delete": delete_dynamic_targeting_key +"/dfareporting:v3.0/dfareporting.dynamicTargetingKeys.delete/name": name +"/dfareporting:v3.0/dfareporting.dynamicTargetingKeys.delete/objectId": object_id_ +"/dfareporting:v3.0/dfareporting.dynamicTargetingKeys.delete/objectType": object_type +"/dfareporting:v3.0/dfareporting.dynamicTargetingKeys.delete/profileId": profile_id +"/dfareporting:v3.0/dfareporting.dynamicTargetingKeys.insert": insert_dynamic_targeting_key +"/dfareporting:v3.0/dfareporting.dynamicTargetingKeys.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.dynamicTargetingKeys.list": list_dynamic_targeting_keys +"/dfareporting:v3.0/dfareporting.dynamicTargetingKeys.list/advertiserId": advertiser_id +"/dfareporting:v3.0/dfareporting.dynamicTargetingKeys.list/names": names +"/dfareporting:v3.0/dfareporting.dynamicTargetingKeys.list/objectId": object_id_ +"/dfareporting:v3.0/dfareporting.dynamicTargetingKeys.list/objectType": object_type +"/dfareporting:v3.0/dfareporting.dynamicTargetingKeys.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.eventTags.delete": delete_event_tag +"/dfareporting:v3.0/dfareporting.eventTags.delete/id": id +"/dfareporting:v3.0/dfareporting.eventTags.delete/profileId": profile_id +"/dfareporting:v3.0/dfareporting.eventTags.get": get_event_tag +"/dfareporting:v3.0/dfareporting.eventTags.get/id": id +"/dfareporting:v3.0/dfareporting.eventTags.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.eventTags.insert": insert_event_tag +"/dfareporting:v3.0/dfareporting.eventTags.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.eventTags.list": list_event_tags +"/dfareporting:v3.0/dfareporting.eventTags.list/adId": ad_id +"/dfareporting:v3.0/dfareporting.eventTags.list/advertiserId": advertiser_id +"/dfareporting:v3.0/dfareporting.eventTags.list/campaignId": campaign_id +"/dfareporting:v3.0/dfareporting.eventTags.list/definitionsOnly": definitions_only +"/dfareporting:v3.0/dfareporting.eventTags.list/enabled": enabled +"/dfareporting:v3.0/dfareporting.eventTags.list/eventTagTypes": event_tag_types +"/dfareporting:v3.0/dfareporting.eventTags.list/ids": ids +"/dfareporting:v3.0/dfareporting.eventTags.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.eventTags.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.eventTags.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.eventTags.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.eventTags.patch": patch_event_tag +"/dfareporting:v3.0/dfareporting.eventTags.patch/id": id +"/dfareporting:v3.0/dfareporting.eventTags.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.eventTags.update": update_event_tag +"/dfareporting:v3.0/dfareporting.eventTags.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.files.get": get_file +"/dfareporting:v3.0/dfareporting.files.get/fileId": file_id +"/dfareporting:v3.0/dfareporting.files.get/reportId": report_id +"/dfareporting:v3.0/dfareporting.files.list": list_files +"/dfareporting:v3.0/dfareporting.files.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.files.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.files.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.files.list/scope": scope +"/dfareporting:v3.0/dfareporting.files.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.files.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.floodlightActivities.delete": delete_floodlight_activity +"/dfareporting:v3.0/dfareporting.floodlightActivities.delete/id": id +"/dfareporting:v3.0/dfareporting.floodlightActivities.delete/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightActivities.generatetag": generatetag_floodlight_activity +"/dfareporting:v3.0/dfareporting.floodlightActivities.generatetag/floodlightActivityId": floodlight_activity_id +"/dfareporting:v3.0/dfareporting.floodlightActivities.generatetag/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightActivities.get": get_floodlight_activity +"/dfareporting:v3.0/dfareporting.floodlightActivities.get/id": id +"/dfareporting:v3.0/dfareporting.floodlightActivities.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightActivities.insert": insert_floodlight_activity +"/dfareporting:v3.0/dfareporting.floodlightActivities.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightActivities.list": list_floodlight_activities +"/dfareporting:v3.0/dfareporting.floodlightActivities.list/advertiserId": advertiser_id +"/dfareporting:v3.0/dfareporting.floodlightActivities.list/floodlightActivityGroupIds": floodlight_activity_group_ids +"/dfareporting:v3.0/dfareporting.floodlightActivities.list/floodlightActivityGroupName": floodlight_activity_group_name +"/dfareporting:v3.0/dfareporting.floodlightActivities.list/floodlightActivityGroupTagString": floodlight_activity_group_tag_string +"/dfareporting:v3.0/dfareporting.floodlightActivities.list/floodlightActivityGroupType": floodlight_activity_group_type +"/dfareporting:v3.0/dfareporting.floodlightActivities.list/floodlightConfigurationId": floodlight_configuration_id +"/dfareporting:v3.0/dfareporting.floodlightActivities.list/ids": ids +"/dfareporting:v3.0/dfareporting.floodlightActivities.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.floodlightActivities.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.floodlightActivities.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightActivities.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.floodlightActivities.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.floodlightActivities.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.floodlightActivities.list/tagString": tag_string +"/dfareporting:v3.0/dfareporting.floodlightActivities.patch": patch_floodlight_activity +"/dfareporting:v3.0/dfareporting.floodlightActivities.patch/id": id +"/dfareporting:v3.0/dfareporting.floodlightActivities.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightActivities.update": update_floodlight_activity +"/dfareporting:v3.0/dfareporting.floodlightActivities.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.get": get_floodlight_activity_group +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.get/id": id +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.insert": insert_floodlight_activity_group +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.list": list_floodlight_activity_groups +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.list/advertiserId": advertiser_id +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.list/floodlightConfigurationId": floodlight_configuration_id +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.list/ids": ids +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.list/type": type +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.patch": patch_floodlight_activity_group +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.patch/id": id +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.update": update_floodlight_activity_group +"/dfareporting:v3.0/dfareporting.floodlightActivityGroups.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightConfigurations.get": get_floodlight_configuration +"/dfareporting:v3.0/dfareporting.floodlightConfigurations.get/id": id +"/dfareporting:v3.0/dfareporting.floodlightConfigurations.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightConfigurations.list": list_floodlight_configurations +"/dfareporting:v3.0/dfareporting.floodlightConfigurations.list/ids": ids +"/dfareporting:v3.0/dfareporting.floodlightConfigurations.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightConfigurations.patch": patch_floodlight_configuration +"/dfareporting:v3.0/dfareporting.floodlightConfigurations.patch/id": id +"/dfareporting:v3.0/dfareporting.floodlightConfigurations.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.floodlightConfigurations.update": update_floodlight_configuration +"/dfareporting:v3.0/dfareporting.floodlightConfigurations.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.inventoryItems.get": get_inventory_item +"/dfareporting:v3.0/dfareporting.inventoryItems.get/id": id +"/dfareporting:v3.0/dfareporting.inventoryItems.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.inventoryItems.get/projectId": project_id +"/dfareporting:v3.0/dfareporting.inventoryItems.list": list_inventory_items +"/dfareporting:v3.0/dfareporting.inventoryItems.list/ids": ids +"/dfareporting:v3.0/dfareporting.inventoryItems.list/inPlan": in_plan +"/dfareporting:v3.0/dfareporting.inventoryItems.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.inventoryItems.list/orderId": order_id +"/dfareporting:v3.0/dfareporting.inventoryItems.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.inventoryItems.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.inventoryItems.list/projectId": project_id +"/dfareporting:v3.0/dfareporting.inventoryItems.list/siteId": site_id +"/dfareporting:v3.0/dfareporting.inventoryItems.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.inventoryItems.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.inventoryItems.list/type": type +"/dfareporting:v3.0/dfareporting.languages.list": list_languages +"/dfareporting:v3.0/dfareporting.languages.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.metros.list": list_metros +"/dfareporting:v3.0/dfareporting.metros.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.mobileCarriers.get": get_mobile_carrier +"/dfareporting:v3.0/dfareporting.mobileCarriers.get/id": id +"/dfareporting:v3.0/dfareporting.mobileCarriers.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.mobileCarriers.list": list_mobile_carriers +"/dfareporting:v3.0/dfareporting.mobileCarriers.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.operatingSystemVersions.get": get_operating_system_version +"/dfareporting:v3.0/dfareporting.operatingSystemVersions.get/id": id +"/dfareporting:v3.0/dfareporting.operatingSystemVersions.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.operatingSystemVersions.list": list_operating_system_versions +"/dfareporting:v3.0/dfareporting.operatingSystemVersions.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.operatingSystems.get": get_operating_system +"/dfareporting:v3.0/dfareporting.operatingSystems.get/dartId": dart_id +"/dfareporting:v3.0/dfareporting.operatingSystems.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.operatingSystems.list": list_operating_systems +"/dfareporting:v3.0/dfareporting.operatingSystems.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.orderDocuments.get": get_order_document +"/dfareporting:v3.0/dfareporting.orderDocuments.get/id": id +"/dfareporting:v3.0/dfareporting.orderDocuments.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.orderDocuments.get/projectId": project_id +"/dfareporting:v3.0/dfareporting.orderDocuments.list": list_order_documents +"/dfareporting:v3.0/dfareporting.orderDocuments.list/approved": approved +"/dfareporting:v3.0/dfareporting.orderDocuments.list/ids": ids +"/dfareporting:v3.0/dfareporting.orderDocuments.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.orderDocuments.list/orderId": order_id +"/dfareporting:v3.0/dfareporting.orderDocuments.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.orderDocuments.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.orderDocuments.list/projectId": project_id +"/dfareporting:v3.0/dfareporting.orderDocuments.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.orderDocuments.list/siteId": site_id +"/dfareporting:v3.0/dfareporting.orderDocuments.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.orderDocuments.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.orders.get": get_order +"/dfareporting:v3.0/dfareporting.orders.get/id": id +"/dfareporting:v3.0/dfareporting.orders.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.orders.get/projectId": project_id +"/dfareporting:v3.0/dfareporting.orders.list": list_orders +"/dfareporting:v3.0/dfareporting.orders.list/ids": ids +"/dfareporting:v3.0/dfareporting.orders.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.orders.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.orders.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.orders.list/projectId": project_id +"/dfareporting:v3.0/dfareporting.orders.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.orders.list/siteId": site_id +"/dfareporting:v3.0/dfareporting.orders.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.orders.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.placementGroups.get": get_placement_group +"/dfareporting:v3.0/dfareporting.placementGroups.get/id": id +"/dfareporting:v3.0/dfareporting.placementGroups.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placementGroups.insert": insert_placement_group +"/dfareporting:v3.0/dfareporting.placementGroups.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placementGroups.list": list_placement_groups +"/dfareporting:v3.0/dfareporting.placementGroups.list/advertiserIds": advertiser_ids +"/dfareporting:v3.0/dfareporting.placementGroups.list/archived": archived +"/dfareporting:v3.0/dfareporting.placementGroups.list/campaignIds": campaign_ids +"/dfareporting:v3.0/dfareporting.placementGroups.list/contentCategoryIds": content_category_ids +"/dfareporting:v3.0/dfareporting.placementGroups.list/directorySiteIds": directory_site_ids +"/dfareporting:v3.0/dfareporting.placementGroups.list/ids": ids +"/dfareporting:v3.0/dfareporting.placementGroups.list/maxEndDate": max_end_date +"/dfareporting:v3.0/dfareporting.placementGroups.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.placementGroups.list/maxStartDate": max_start_date +"/dfareporting:v3.0/dfareporting.placementGroups.list/minEndDate": min_end_date +"/dfareporting:v3.0/dfareporting.placementGroups.list/minStartDate": min_start_date +"/dfareporting:v3.0/dfareporting.placementGroups.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.placementGroups.list/placementGroupType": placement_group_type +"/dfareporting:v3.0/dfareporting.placementGroups.list/placementStrategyIds": placement_strategy_ids +"/dfareporting:v3.0/dfareporting.placementGroups.list/pricingTypes": pricing_types +"/dfareporting:v3.0/dfareporting.placementGroups.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placementGroups.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.placementGroups.list/siteIds": site_ids +"/dfareporting:v3.0/dfareporting.placementGroups.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.placementGroups.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.placementGroups.patch": patch_placement_group +"/dfareporting:v3.0/dfareporting.placementGroups.patch/id": id +"/dfareporting:v3.0/dfareporting.placementGroups.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placementGroups.update": update_placement_group +"/dfareporting:v3.0/dfareporting.placementGroups.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placementStrategies.delete": delete_placement_strategy +"/dfareporting:v3.0/dfareporting.placementStrategies.delete/id": id +"/dfareporting:v3.0/dfareporting.placementStrategies.delete/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placementStrategies.get": get_placement_strategy +"/dfareporting:v3.0/dfareporting.placementStrategies.get/id": id +"/dfareporting:v3.0/dfareporting.placementStrategies.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placementStrategies.insert": insert_placement_strategy +"/dfareporting:v3.0/dfareporting.placementStrategies.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placementStrategies.list": list_placement_strategies +"/dfareporting:v3.0/dfareporting.placementStrategies.list/ids": ids +"/dfareporting:v3.0/dfareporting.placementStrategies.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.placementStrategies.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.placementStrategies.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placementStrategies.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.placementStrategies.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.placementStrategies.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.placementStrategies.patch": patch_placement_strategy +"/dfareporting:v3.0/dfareporting.placementStrategies.patch/id": id +"/dfareporting:v3.0/dfareporting.placementStrategies.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placementStrategies.update": update_placement_strategy +"/dfareporting:v3.0/dfareporting.placementStrategies.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placements.generatetags": generatetags_placement +"/dfareporting:v3.0/dfareporting.placements.generatetags/campaignId": campaign_id +"/dfareporting:v3.0/dfareporting.placements.generatetags/placementIds": placement_ids +"/dfareporting:v3.0/dfareporting.placements.generatetags/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placements.generatetags/tagFormats": tag_formats +"/dfareporting:v3.0/dfareporting.placements.get": get_placement +"/dfareporting:v3.0/dfareporting.placements.get/id": id +"/dfareporting:v3.0/dfareporting.placements.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placements.insert": insert_placement +"/dfareporting:v3.0/dfareporting.placements.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placements.list": list_placements +"/dfareporting:v3.0/dfareporting.placements.list/advertiserIds": advertiser_ids +"/dfareporting:v3.0/dfareporting.placements.list/archived": archived +"/dfareporting:v3.0/dfareporting.placements.list/campaignIds": campaign_ids +"/dfareporting:v3.0/dfareporting.placements.list/compatibilities": compatibilities +"/dfareporting:v3.0/dfareporting.placements.list/contentCategoryIds": content_category_ids +"/dfareporting:v3.0/dfareporting.placements.list/directorySiteIds": directory_site_ids +"/dfareporting:v3.0/dfareporting.placements.list/groupIds": group_ids +"/dfareporting:v3.0/dfareporting.placements.list/ids": ids +"/dfareporting:v3.0/dfareporting.placements.list/maxEndDate": max_end_date +"/dfareporting:v3.0/dfareporting.placements.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.placements.list/maxStartDate": max_start_date +"/dfareporting:v3.0/dfareporting.placements.list/minEndDate": min_end_date +"/dfareporting:v3.0/dfareporting.placements.list/minStartDate": min_start_date +"/dfareporting:v3.0/dfareporting.placements.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.placements.list/paymentSource": payment_source +"/dfareporting:v3.0/dfareporting.placements.list/placementStrategyIds": placement_strategy_ids +"/dfareporting:v3.0/dfareporting.placements.list/pricingTypes": pricing_types +"/dfareporting:v3.0/dfareporting.placements.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placements.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.placements.list/siteIds": site_ids +"/dfareporting:v3.0/dfareporting.placements.list/sizeIds": size_ids +"/dfareporting:v3.0/dfareporting.placements.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.placements.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.placements.patch": patch_placement +"/dfareporting:v3.0/dfareporting.placements.patch/id": id +"/dfareporting:v3.0/dfareporting.placements.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.placements.update": update_placement +"/dfareporting:v3.0/dfareporting.placements.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.platformTypes.get": get_platform_type +"/dfareporting:v3.0/dfareporting.platformTypes.get/id": id +"/dfareporting:v3.0/dfareporting.platformTypes.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.platformTypes.list": list_platform_types +"/dfareporting:v3.0/dfareporting.platformTypes.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.postalCodes.get": get_postal_code +"/dfareporting:v3.0/dfareporting.postalCodes.get/code": code +"/dfareporting:v3.0/dfareporting.postalCodes.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.postalCodes.list": list_postal_codes +"/dfareporting:v3.0/dfareporting.postalCodes.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.projects.get": get_project +"/dfareporting:v3.0/dfareporting.projects.get/id": id +"/dfareporting:v3.0/dfareporting.projects.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.projects.list": list_projects +"/dfareporting:v3.0/dfareporting.projects.list/advertiserIds": advertiser_ids +"/dfareporting:v3.0/dfareporting.projects.list/ids": ids +"/dfareporting:v3.0/dfareporting.projects.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.projects.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.projects.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.projects.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.projects.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.projects.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.regions.list": list_regions +"/dfareporting:v3.0/dfareporting.regions.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.remarketingListShares.get": get_remarketing_list_share +"/dfareporting:v3.0/dfareporting.remarketingListShares.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.remarketingListShares.get/remarketingListId": remarketing_list_id +"/dfareporting:v3.0/dfareporting.remarketingListShares.patch": patch_remarketing_list_share +"/dfareporting:v3.0/dfareporting.remarketingListShares.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.remarketingListShares.patch/remarketingListId": remarketing_list_id +"/dfareporting:v3.0/dfareporting.remarketingListShares.update": update_remarketing_list_share +"/dfareporting:v3.0/dfareporting.remarketingListShares.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.remarketingLists.get": get_remarketing_list +"/dfareporting:v3.0/dfareporting.remarketingLists.get/id": id +"/dfareporting:v3.0/dfareporting.remarketingLists.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.remarketingLists.insert": insert_remarketing_list +"/dfareporting:v3.0/dfareporting.remarketingLists.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.remarketingLists.list": list_remarketing_lists +"/dfareporting:v3.0/dfareporting.remarketingLists.list/active": active +"/dfareporting:v3.0/dfareporting.remarketingLists.list/advertiserId": advertiser_id +"/dfareporting:v3.0/dfareporting.remarketingLists.list/floodlightActivityId": floodlight_activity_id +"/dfareporting:v3.0/dfareporting.remarketingLists.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.remarketingLists.list/name": name +"/dfareporting:v3.0/dfareporting.remarketingLists.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.remarketingLists.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.remarketingLists.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.remarketingLists.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.remarketingLists.patch": patch_remarketing_list +"/dfareporting:v3.0/dfareporting.remarketingLists.patch/id": id +"/dfareporting:v3.0/dfareporting.remarketingLists.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.remarketingLists.update": update_remarketing_list +"/dfareporting:v3.0/dfareporting.remarketingLists.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.reports.compatibleFields.query": query_report_compatible_field +"/dfareporting:v3.0/dfareporting.reports.compatibleFields.query/profileId": profile_id +"/dfareporting:v3.0/dfareporting.reports.delete": delete_report +"/dfareporting:v3.0/dfareporting.reports.delete/profileId": profile_id +"/dfareporting:v3.0/dfareporting.reports.delete/reportId": report_id +"/dfareporting:v3.0/dfareporting.reports.files.get": get_report_file +"/dfareporting:v3.0/dfareporting.reports.files.get/fileId": file_id +"/dfareporting:v3.0/dfareporting.reports.files.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.reports.files.get/reportId": report_id +"/dfareporting:v3.0/dfareporting.reports.files.list": list_report_files +"/dfareporting:v3.0/dfareporting.reports.files.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.reports.files.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.reports.files.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.reports.files.list/reportId": report_id +"/dfareporting:v3.0/dfareporting.reports.files.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.reports.files.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.reports.get": get_report +"/dfareporting:v3.0/dfareporting.reports.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.reports.get/reportId": report_id +"/dfareporting:v3.0/dfareporting.reports.insert": insert_report +"/dfareporting:v3.0/dfareporting.reports.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.reports.list": list_reports +"/dfareporting:v3.0/dfareporting.reports.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.reports.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.reports.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.reports.list/scope": scope +"/dfareporting:v3.0/dfareporting.reports.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.reports.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.reports.patch": patch_report +"/dfareporting:v3.0/dfareporting.reports.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.reports.patch/reportId": report_id +"/dfareporting:v3.0/dfareporting.reports.run": run_report +"/dfareporting:v3.0/dfareporting.reports.run/profileId": profile_id +"/dfareporting:v3.0/dfareporting.reports.run/reportId": report_id +"/dfareporting:v3.0/dfareporting.reports.run/synchronous": synchronous +"/dfareporting:v3.0/dfareporting.reports.update": update_report +"/dfareporting:v3.0/dfareporting.reports.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.reports.update/reportId": report_id +"/dfareporting:v3.0/dfareporting.sites.get": get_site +"/dfareporting:v3.0/dfareporting.sites.get/id": id +"/dfareporting:v3.0/dfareporting.sites.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.sites.insert": insert_site +"/dfareporting:v3.0/dfareporting.sites.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.sites.list": list_sites +"/dfareporting:v3.0/dfareporting.sites.list/acceptsInStreamVideoPlacements": accepts_in_stream_video_placements +"/dfareporting:v3.0/dfareporting.sites.list/acceptsInterstitialPlacements": accepts_interstitial_placements +"/dfareporting:v3.0/dfareporting.sites.list/acceptsPublisherPaidPlacements": accepts_publisher_paid_placements +"/dfareporting:v3.0/dfareporting.sites.list/adWordsSite": ad_words_site +"/dfareporting:v3.0/dfareporting.sites.list/approved": approved +"/dfareporting:v3.0/dfareporting.sites.list/campaignIds": campaign_ids +"/dfareporting:v3.0/dfareporting.sites.list/directorySiteIds": directory_site_ids +"/dfareporting:v3.0/dfareporting.sites.list/ids": ids +"/dfareporting:v3.0/dfareporting.sites.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.sites.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.sites.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.sites.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.sites.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.sites.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.sites.list/subaccountId": subaccount_id +"/dfareporting:v3.0/dfareporting.sites.list/unmappedSite": unmapped_site +"/dfareporting:v3.0/dfareporting.sites.patch": patch_site +"/dfareporting:v3.0/dfareporting.sites.patch/id": id +"/dfareporting:v3.0/dfareporting.sites.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.sites.update": update_site +"/dfareporting:v3.0/dfareporting.sites.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.sizes.get": get_size +"/dfareporting:v3.0/dfareporting.sizes.get/id": id +"/dfareporting:v3.0/dfareporting.sizes.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.sizes.insert": insert_size +"/dfareporting:v3.0/dfareporting.sizes.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.sizes.list": list_sizes +"/dfareporting:v3.0/dfareporting.sizes.list/height": height +"/dfareporting:v3.0/dfareporting.sizes.list/iabStandard": iab_standard +"/dfareporting:v3.0/dfareporting.sizes.list/ids": ids +"/dfareporting:v3.0/dfareporting.sizes.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.sizes.list/width": width +"/dfareporting:v3.0/dfareporting.subaccounts.get": get_subaccount +"/dfareporting:v3.0/dfareporting.subaccounts.get/id": id +"/dfareporting:v3.0/dfareporting.subaccounts.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.subaccounts.insert": insert_subaccount +"/dfareporting:v3.0/dfareporting.subaccounts.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.subaccounts.list": list_subaccounts +"/dfareporting:v3.0/dfareporting.subaccounts.list/ids": ids +"/dfareporting:v3.0/dfareporting.subaccounts.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.subaccounts.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.subaccounts.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.subaccounts.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.subaccounts.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.subaccounts.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.subaccounts.patch": patch_subaccount +"/dfareporting:v3.0/dfareporting.subaccounts.patch/id": id +"/dfareporting:v3.0/dfareporting.subaccounts.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.subaccounts.update": update_subaccount +"/dfareporting:v3.0/dfareporting.subaccounts.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.targetableRemarketingLists.get": get_targetable_remarketing_list +"/dfareporting:v3.0/dfareporting.targetableRemarketingLists.get/id": id +"/dfareporting:v3.0/dfareporting.targetableRemarketingLists.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.targetableRemarketingLists.list": list_targetable_remarketing_lists +"/dfareporting:v3.0/dfareporting.targetableRemarketingLists.list/active": active +"/dfareporting:v3.0/dfareporting.targetableRemarketingLists.list/advertiserId": advertiser_id +"/dfareporting:v3.0/dfareporting.targetableRemarketingLists.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.targetableRemarketingLists.list/name": name +"/dfareporting:v3.0/dfareporting.targetableRemarketingLists.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.targetableRemarketingLists.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.targetableRemarketingLists.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.targetableRemarketingLists.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.targetingTemplates.get": get_targeting_template +"/dfareporting:v3.0/dfareporting.targetingTemplates.get/id": id +"/dfareporting:v3.0/dfareporting.targetingTemplates.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.targetingTemplates.insert": insert_targeting_template +"/dfareporting:v3.0/dfareporting.targetingTemplates.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.targetingTemplates.list": list_targeting_templates +"/dfareporting:v3.0/dfareporting.targetingTemplates.list/advertiserId": advertiser_id +"/dfareporting:v3.0/dfareporting.targetingTemplates.list/ids": ids +"/dfareporting:v3.0/dfareporting.targetingTemplates.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.targetingTemplates.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.targetingTemplates.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.targetingTemplates.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.targetingTemplates.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.targetingTemplates.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.targetingTemplates.patch": patch_targeting_template +"/dfareporting:v3.0/dfareporting.targetingTemplates.patch/id": id +"/dfareporting:v3.0/dfareporting.targetingTemplates.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.targetingTemplates.update": update_targeting_template +"/dfareporting:v3.0/dfareporting.targetingTemplates.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.userProfiles.get": get_user_profile +"/dfareporting:v3.0/dfareporting.userProfiles.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.userProfiles.list": list_user_profiles +"/dfareporting:v3.0/dfareporting.userRolePermissionGroups.get": get_user_role_permission_group +"/dfareporting:v3.0/dfareporting.userRolePermissionGroups.get/id": id +"/dfareporting:v3.0/dfareporting.userRolePermissionGroups.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.userRolePermissionGroups.list": list_user_role_permission_groups +"/dfareporting:v3.0/dfareporting.userRolePermissionGroups.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.userRolePermissions.get": get_user_role_permission +"/dfareporting:v3.0/dfareporting.userRolePermissions.get/id": id +"/dfareporting:v3.0/dfareporting.userRolePermissions.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.userRolePermissions.list": list_user_role_permissions +"/dfareporting:v3.0/dfareporting.userRolePermissions.list/ids": ids +"/dfareporting:v3.0/dfareporting.userRolePermissions.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.userRoles.delete": delete_user_role +"/dfareporting:v3.0/dfareporting.userRoles.delete/id": id +"/dfareporting:v3.0/dfareporting.userRoles.delete/profileId": profile_id +"/dfareporting:v3.0/dfareporting.userRoles.get": get_user_role +"/dfareporting:v3.0/dfareporting.userRoles.get/id": id +"/dfareporting:v3.0/dfareporting.userRoles.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.userRoles.insert": insert_user_role +"/dfareporting:v3.0/dfareporting.userRoles.insert/profileId": profile_id +"/dfareporting:v3.0/dfareporting.userRoles.list": list_user_roles +"/dfareporting:v3.0/dfareporting.userRoles.list/accountUserRoleOnly": account_user_role_only +"/dfareporting:v3.0/dfareporting.userRoles.list/ids": ids +"/dfareporting:v3.0/dfareporting.userRoles.list/maxResults": max_results +"/dfareporting:v3.0/dfareporting.userRoles.list/pageToken": page_token +"/dfareporting:v3.0/dfareporting.userRoles.list/profileId": profile_id +"/dfareporting:v3.0/dfareporting.userRoles.list/searchString": search_string +"/dfareporting:v3.0/dfareporting.userRoles.list/sortField": sort_field +"/dfareporting:v3.0/dfareporting.userRoles.list/sortOrder": sort_order +"/dfareporting:v3.0/dfareporting.userRoles.list/subaccountId": subaccount_id +"/dfareporting:v3.0/dfareporting.userRoles.patch": patch_user_role +"/dfareporting:v3.0/dfareporting.userRoles.patch/id": id +"/dfareporting:v3.0/dfareporting.userRoles.patch/profileId": profile_id +"/dfareporting:v3.0/dfareporting.userRoles.update": update_user_role +"/dfareporting:v3.0/dfareporting.userRoles.update/profileId": profile_id +"/dfareporting:v3.0/dfareporting.videoFormats.get": get_video_format +"/dfareporting:v3.0/dfareporting.videoFormats.get/id": id +"/dfareporting:v3.0/dfareporting.videoFormats.get/profileId": profile_id +"/dfareporting:v3.0/dfareporting.videoFormats.list": list_video_formats +"/dfareporting:v3.0/dfareporting.videoFormats.list/profileId": profile_id +"/dfareporting:v3.0/fields": fields +"/dfareporting:v3.0/key": key +"/dfareporting:v3.0/quotaUser": quota_user +"/dfareporting:v3.0/userIp": user_ip +"/dialogflow:v2beta1/Agent": agent +"/dialogflow:v2beta1/Agent/avatarUri": avatar_uri +"/dialogflow:v2beta1/Agent/classificationThreshold": classification_threshold +"/dialogflow:v2beta1/Agent/defaultLanguageCode": default_language_code +"/dialogflow:v2beta1/Agent/description": description +"/dialogflow:v2beta1/Agent/displayName": display_name +"/dialogflow:v2beta1/Agent/enableLogging": enable_logging +"/dialogflow:v2beta1/Agent/matchMode": match_mode +"/dialogflow:v2beta1/Agent/parent": parent +"/dialogflow:v2beta1/Agent/supportedLanguageCodes": supported_language_codes +"/dialogflow:v2beta1/Agent/supportedLanguageCodes/supported_language_code": supported_language_code +"/dialogflow:v2beta1/Agent/timeZone": time_zone +"/dialogflow:v2beta1/BatchCreateEntitiesRequest": batch_create_entities_request +"/dialogflow:v2beta1/BatchCreateEntitiesRequest/entities": entities +"/dialogflow:v2beta1/BatchCreateEntitiesRequest/entities/entity": entity +"/dialogflow:v2beta1/BatchCreateEntitiesRequest/languageCode": language_code +"/dialogflow:v2beta1/BatchDeleteEntitiesRequest": batch_delete_entities_request +"/dialogflow:v2beta1/BatchDeleteEntitiesRequest/entityValues": entity_values +"/dialogflow:v2beta1/BatchDeleteEntitiesRequest/entityValues/entity_value": entity_value +"/dialogflow:v2beta1/BatchDeleteEntitiesRequest/languageCode": language_code +"/dialogflow:v2beta1/BatchDeleteEntityTypesRequest": batch_delete_entity_types_request +"/dialogflow:v2beta1/BatchDeleteEntityTypesRequest/entityTypeNames": entity_type_names +"/dialogflow:v2beta1/BatchDeleteEntityTypesRequest/entityTypeNames/entity_type_name": entity_type_name +"/dialogflow:v2beta1/BatchDeleteIntentsRequest": batch_delete_intents_request +"/dialogflow:v2beta1/BatchDeleteIntentsRequest/intents": intents +"/dialogflow:v2beta1/BatchDeleteIntentsRequest/intents/intent": intent +"/dialogflow:v2beta1/BatchUpdateEntitiesRequest": batch_update_entities_request +"/dialogflow:v2beta1/BatchUpdateEntitiesRequest/entities": entities +"/dialogflow:v2beta1/BatchUpdateEntitiesRequest/entities/entity": entity +"/dialogflow:v2beta1/BatchUpdateEntitiesRequest/languageCode": language_code +"/dialogflow:v2beta1/BatchUpdateEntitiesRequest/updateMask": update_mask +"/dialogflow:v2beta1/BatchUpdateEntityTypesRequest": batch_update_entity_types_request +"/dialogflow:v2beta1/BatchUpdateEntityTypesRequest/entityTypeBatchInline": entity_type_batch_inline +"/dialogflow:v2beta1/BatchUpdateEntityTypesRequest/entityTypeBatchUri": entity_type_batch_uri +"/dialogflow:v2beta1/BatchUpdateEntityTypesRequest/languageCode": language_code +"/dialogflow:v2beta1/BatchUpdateEntityTypesRequest/updateMask": update_mask +"/dialogflow:v2beta1/BatchUpdateEntityTypesResponse": batch_update_entity_types_response +"/dialogflow:v2beta1/BatchUpdateEntityTypesResponse/entityTypes": entity_types +"/dialogflow:v2beta1/BatchUpdateEntityTypesResponse/entityTypes/entity_type": entity_type +"/dialogflow:v2beta1/BatchUpdateIntentsRequest": batch_update_intents_request +"/dialogflow:v2beta1/BatchUpdateIntentsRequest/intentBatchInline": intent_batch_inline +"/dialogflow:v2beta1/BatchUpdateIntentsRequest/intentBatchUri": intent_batch_uri +"/dialogflow:v2beta1/BatchUpdateIntentsRequest/intentView": intent_view +"/dialogflow:v2beta1/BatchUpdateIntentsRequest/languageCode": language_code +"/dialogflow:v2beta1/BatchUpdateIntentsRequest/updateMask": update_mask +"/dialogflow:v2beta1/BatchUpdateIntentsResponse": batch_update_intents_response +"/dialogflow:v2beta1/BatchUpdateIntentsResponse/intents": intents +"/dialogflow:v2beta1/BatchUpdateIntentsResponse/intents/intent": intent +"/dialogflow:v2beta1/Context": context +"/dialogflow:v2beta1/Context/lifespanCount": lifespan_count +"/dialogflow:v2beta1/Context/name": name +"/dialogflow:v2beta1/Context/parameters": parameters +"/dialogflow:v2beta1/Context/parameters/parameter": parameter +"/dialogflow:v2beta1/DetectIntentRequest": detect_intent_request +"/dialogflow:v2beta1/DetectIntentRequest/inputAudio": input_audio +"/dialogflow:v2beta1/DetectIntentRequest/queryInput": query_input +"/dialogflow:v2beta1/DetectIntentRequest/queryParams": query_params +"/dialogflow:v2beta1/DetectIntentResponse": detect_intent_response +"/dialogflow:v2beta1/DetectIntentResponse/queryResult": query_result +"/dialogflow:v2beta1/DetectIntentResponse/responseId": response_id +"/dialogflow:v2beta1/DetectIntentResponse/webhookStatus": webhook_status +"/dialogflow:v2beta1/Empty": empty +"/dialogflow:v2beta1/EntityType": entity_type +"/dialogflow:v2beta1/EntityType/autoExpansionMode": auto_expansion_mode +"/dialogflow:v2beta1/EntityType/displayName": display_name +"/dialogflow:v2beta1/EntityType/entities": entities +"/dialogflow:v2beta1/EntityType/entities/entity": entity +"/dialogflow:v2beta1/EntityType/kind": kind +"/dialogflow:v2beta1/EntityType/name": name +"/dialogflow:v2beta1/EntityTypeBatch": entity_type_batch +"/dialogflow:v2beta1/EntityTypeBatch/entityTypes": entity_types +"/dialogflow:v2beta1/EntityTypeBatch/entityTypes/entity_type": entity_type +"/dialogflow:v2beta1/EntityTypeEntity": entity_type_entity +"/dialogflow:v2beta1/EntityTypeEntity/synonyms": synonyms +"/dialogflow:v2beta1/EntityTypeEntity/synonyms/synonym": synonym +"/dialogflow:v2beta1/EntityTypeEntity/value": value +"/dialogflow:v2beta1/EventInput": event_input +"/dialogflow:v2beta1/EventInput/languageCode": language_code +"/dialogflow:v2beta1/EventInput/name": name +"/dialogflow:v2beta1/EventInput/parameters": parameters +"/dialogflow:v2beta1/EventInput/parameters/parameter": parameter +"/dialogflow:v2beta1/ExportAgentRequest": export_agent_request +"/dialogflow:v2beta1/ExportAgentRequest/agentUri": agent_uri +"/dialogflow:v2beta1/ExportAgentResponse": export_agent_response +"/dialogflow:v2beta1/ExportAgentResponse/agentContent": agent_content +"/dialogflow:v2beta1/ExportAgentResponse/agentUri": agent_uri +"/dialogflow:v2beta1/ImportAgentRequest": import_agent_request +"/dialogflow:v2beta1/ImportAgentRequest/agentContent": agent_content +"/dialogflow:v2beta1/ImportAgentRequest/agentUri": agent_uri +"/dialogflow:v2beta1/InputAudioConfig": input_audio_config +"/dialogflow:v2beta1/InputAudioConfig/audioEncoding": audio_encoding +"/dialogflow:v2beta1/InputAudioConfig/languageCode": language_code +"/dialogflow:v2beta1/InputAudioConfig/phraseHints": phrase_hints +"/dialogflow:v2beta1/InputAudioConfig/phraseHints/phrase_hint": phrase_hint +"/dialogflow:v2beta1/InputAudioConfig/sampleRateHertz": sample_rate_hertz +"/dialogflow:v2beta1/Intent": intent +"/dialogflow:v2beta1/Intent/action": action +"/dialogflow:v2beta1/Intent/defaultResponsePlatforms": default_response_platforms +"/dialogflow:v2beta1/Intent/defaultResponsePlatforms/default_response_platform": default_response_platform +"/dialogflow:v2beta1/Intent/displayName": display_name +"/dialogflow:v2beta1/Intent/events": events +"/dialogflow:v2beta1/Intent/events/event": event +"/dialogflow:v2beta1/Intent/followupIntentInfo": followup_intent_info +"/dialogflow:v2beta1/Intent/followupIntentInfo/followup_intent_info": followup_intent_info +"/dialogflow:v2beta1/Intent/inputContextNames": input_context_names +"/dialogflow:v2beta1/Intent/inputContextNames/input_context_name": input_context_name +"/dialogflow:v2beta1/Intent/isFallback": is_fallback +"/dialogflow:v2beta1/Intent/messages": messages +"/dialogflow:v2beta1/Intent/messages/message": message +"/dialogflow:v2beta1/Intent/mlEnabled": ml_enabled +"/dialogflow:v2beta1/Intent/name": name +"/dialogflow:v2beta1/Intent/outputContexts": output_contexts +"/dialogflow:v2beta1/Intent/outputContexts/output_context": output_context +"/dialogflow:v2beta1/Intent/parameters": parameters +"/dialogflow:v2beta1/Intent/parameters/parameter": parameter +"/dialogflow:v2beta1/Intent/parentFollowupIntentName": parent_followup_intent_name +"/dialogflow:v2beta1/Intent/priority": priority +"/dialogflow:v2beta1/Intent/resetContexts": reset_contexts +"/dialogflow:v2beta1/Intent/rootFollowupIntentName": root_followup_intent_name +"/dialogflow:v2beta1/Intent/trainingPhrases": training_phrases +"/dialogflow:v2beta1/Intent/trainingPhrases/training_phrase": training_phrase +"/dialogflow:v2beta1/Intent/webhookState": webhook_state +"/dialogflow:v2beta1/IntentBatch": intent_batch +"/dialogflow:v2beta1/IntentBatch/intents": intents +"/dialogflow:v2beta1/IntentBatch/intents/intent": intent +"/dialogflow:v2beta1/IntentFollowupIntentInfo": intent_followup_intent_info +"/dialogflow:v2beta1/IntentFollowupIntentInfo/followupIntentName": followup_intent_name +"/dialogflow:v2beta1/IntentFollowupIntentInfo/parentFollowupIntentName": parent_followup_intent_name +"/dialogflow:v2beta1/IntentMessage": intent_message +"/dialogflow:v2beta1/IntentMessage/basicCard": basic_card +"/dialogflow:v2beta1/IntentMessage/card": card +"/dialogflow:v2beta1/IntentMessage/carouselSelect": carousel_select +"/dialogflow:v2beta1/IntentMessage/image": image +"/dialogflow:v2beta1/IntentMessage/linkOutSuggestion": link_out_suggestion +"/dialogflow:v2beta1/IntentMessage/listSelect": list_select +"/dialogflow:v2beta1/IntentMessage/payload": payload +"/dialogflow:v2beta1/IntentMessage/payload/payload": payload +"/dialogflow:v2beta1/IntentMessage/platform": platform +"/dialogflow:v2beta1/IntentMessage/quickReplies": quick_replies +"/dialogflow:v2beta1/IntentMessage/simpleResponses": simple_responses +"/dialogflow:v2beta1/IntentMessage/suggestions": suggestions +"/dialogflow:v2beta1/IntentMessage/text": text +"/dialogflow:v2beta1/IntentMessageBasicCard": intent_message_basic_card +"/dialogflow:v2beta1/IntentMessageBasicCard/buttons": buttons +"/dialogflow:v2beta1/IntentMessageBasicCard/buttons/button": button +"/dialogflow:v2beta1/IntentMessageBasicCard/formattedText": formatted_text +"/dialogflow:v2beta1/IntentMessageBasicCard/image": image +"/dialogflow:v2beta1/IntentMessageBasicCard/subtitle": subtitle +"/dialogflow:v2beta1/IntentMessageBasicCard/title": title +"/dialogflow:v2beta1/IntentMessageBasicCardButton": intent_message_basic_card_button +"/dialogflow:v2beta1/IntentMessageBasicCardButton/openUriAction": open_uri_action +"/dialogflow:v2beta1/IntentMessageBasicCardButton/title": title +"/dialogflow:v2beta1/IntentMessageBasicCardButtonOpenUriAction": intent_message_basic_card_button_open_uri_action +"/dialogflow:v2beta1/IntentMessageBasicCardButtonOpenUriAction/uri": uri +"/dialogflow:v2beta1/IntentMessageCard": intent_message_card +"/dialogflow:v2beta1/IntentMessageCard/buttons": buttons +"/dialogflow:v2beta1/IntentMessageCard/buttons/button": button +"/dialogflow:v2beta1/IntentMessageCard/imageUri": image_uri +"/dialogflow:v2beta1/IntentMessageCard/subtitle": subtitle +"/dialogflow:v2beta1/IntentMessageCard/title": title +"/dialogflow:v2beta1/IntentMessageCardButton": intent_message_card_button +"/dialogflow:v2beta1/IntentMessageCardButton/postback": postback +"/dialogflow:v2beta1/IntentMessageCardButton/text": text +"/dialogflow:v2beta1/IntentMessageCarouselSelect": intent_message_carousel_select +"/dialogflow:v2beta1/IntentMessageCarouselSelect/items": items +"/dialogflow:v2beta1/IntentMessageCarouselSelect/items/item": item +"/dialogflow:v2beta1/IntentMessageCarouselSelectItem": intent_message_carousel_select_item +"/dialogflow:v2beta1/IntentMessageCarouselSelectItem/description": description +"/dialogflow:v2beta1/IntentMessageCarouselSelectItem/image": image +"/dialogflow:v2beta1/IntentMessageCarouselSelectItem/info": info +"/dialogflow:v2beta1/IntentMessageCarouselSelectItem/title": title +"/dialogflow:v2beta1/IntentMessageImage": intent_message_image +"/dialogflow:v2beta1/IntentMessageImage/imageUri": image_uri +"/dialogflow:v2beta1/IntentMessageLinkOutSuggestion": intent_message_link_out_suggestion +"/dialogflow:v2beta1/IntentMessageLinkOutSuggestion/destinationName": destination_name +"/dialogflow:v2beta1/IntentMessageLinkOutSuggestion/uri": uri +"/dialogflow:v2beta1/IntentMessageListSelect": intent_message_list_select +"/dialogflow:v2beta1/IntentMessageListSelect/items": items +"/dialogflow:v2beta1/IntentMessageListSelect/items/item": item +"/dialogflow:v2beta1/IntentMessageListSelect/title": title +"/dialogflow:v2beta1/IntentMessageListSelectItem": intent_message_list_select_item +"/dialogflow:v2beta1/IntentMessageListSelectItem/description": description +"/dialogflow:v2beta1/IntentMessageListSelectItem/image": image +"/dialogflow:v2beta1/IntentMessageListSelectItem/info": info +"/dialogflow:v2beta1/IntentMessageListSelectItem/title": title +"/dialogflow:v2beta1/IntentMessageQuickReplies": intent_message_quick_replies +"/dialogflow:v2beta1/IntentMessageQuickReplies/quickReplies": quick_replies +"/dialogflow:v2beta1/IntentMessageQuickReplies/quickReplies/quick_reply": quick_reply +"/dialogflow:v2beta1/IntentMessageQuickReplies/title": title +"/dialogflow:v2beta1/IntentMessageSelectItemInfo": intent_message_select_item_info +"/dialogflow:v2beta1/IntentMessageSelectItemInfo/key": key +"/dialogflow:v2beta1/IntentMessageSelectItemInfo/synonyms": synonyms +"/dialogflow:v2beta1/IntentMessageSelectItemInfo/synonyms/synonym": synonym +"/dialogflow:v2beta1/IntentMessageSimpleResponse": intent_message_simple_response +"/dialogflow:v2beta1/IntentMessageSimpleResponse/displayText": display_text +"/dialogflow:v2beta1/IntentMessageSimpleResponse/ssml": ssml +"/dialogflow:v2beta1/IntentMessageSimpleResponse/textToSpeech": text_to_speech +"/dialogflow:v2beta1/IntentMessageSimpleResponses": intent_message_simple_responses +"/dialogflow:v2beta1/IntentMessageSimpleResponses/simpleResponses": simple_responses +"/dialogflow:v2beta1/IntentMessageSimpleResponses/simpleResponses/simple_response": simple_response +"/dialogflow:v2beta1/IntentMessageSuggestion": intent_message_suggestion +"/dialogflow:v2beta1/IntentMessageSuggestion/title": title +"/dialogflow:v2beta1/IntentMessageSuggestions": intent_message_suggestions +"/dialogflow:v2beta1/IntentMessageSuggestions/suggestions": suggestions +"/dialogflow:v2beta1/IntentMessageSuggestions/suggestions/suggestion": suggestion +"/dialogflow:v2beta1/IntentMessageText": intent_message_text +"/dialogflow:v2beta1/IntentMessageText/text": text +"/dialogflow:v2beta1/IntentMessageText/text/text": text +"/dialogflow:v2beta1/IntentParameter": intent_parameter +"/dialogflow:v2beta1/IntentParameter/defaultValue": default_value +"/dialogflow:v2beta1/IntentParameter/displayName": display_name +"/dialogflow:v2beta1/IntentParameter/entityTypeDisplayName": entity_type_display_name +"/dialogflow:v2beta1/IntentParameter/isList": is_list +"/dialogflow:v2beta1/IntentParameter/mandatory": mandatory +"/dialogflow:v2beta1/IntentParameter/name": name +"/dialogflow:v2beta1/IntentParameter/prompts": prompts +"/dialogflow:v2beta1/IntentParameter/prompts/prompt": prompt +"/dialogflow:v2beta1/IntentParameter/value": value +"/dialogflow:v2beta1/IntentTrainingPhrase": intent_training_phrase +"/dialogflow:v2beta1/IntentTrainingPhrase/name": name +"/dialogflow:v2beta1/IntentTrainingPhrase/parts": parts +"/dialogflow:v2beta1/IntentTrainingPhrase/parts/part": part +"/dialogflow:v2beta1/IntentTrainingPhrase/timesAddedCount": times_added_count +"/dialogflow:v2beta1/IntentTrainingPhrase/type": type +"/dialogflow:v2beta1/IntentTrainingPhrasePart": intent_training_phrase_part +"/dialogflow:v2beta1/IntentTrainingPhrasePart/alias": alias +"/dialogflow:v2beta1/IntentTrainingPhrasePart/entityType": entity_type +"/dialogflow:v2beta1/IntentTrainingPhrasePart/text": text +"/dialogflow:v2beta1/IntentTrainingPhrasePart/userDefined": user_defined +"/dialogflow:v2beta1/LatLng": lat_lng +"/dialogflow:v2beta1/LatLng/latitude": latitude +"/dialogflow:v2beta1/LatLng/longitude": longitude +"/dialogflow:v2beta1/ListContextsResponse": list_contexts_response +"/dialogflow:v2beta1/ListContextsResponse/contexts": contexts +"/dialogflow:v2beta1/ListContextsResponse/contexts/context": context +"/dialogflow:v2beta1/ListContextsResponse/nextPageToken": next_page_token +"/dialogflow:v2beta1/ListEntityTypesResponse": list_entity_types_response +"/dialogflow:v2beta1/ListEntityTypesResponse/entityTypes": entity_types +"/dialogflow:v2beta1/ListEntityTypesResponse/entityTypes/entity_type": entity_type +"/dialogflow:v2beta1/ListEntityTypesResponse/nextPageToken": next_page_token +"/dialogflow:v2beta1/ListIntentsResponse": list_intents_response +"/dialogflow:v2beta1/ListIntentsResponse/intents": intents +"/dialogflow:v2beta1/ListIntentsResponse/intents/intent": intent +"/dialogflow:v2beta1/ListIntentsResponse/nextPageToken": next_page_token +"/dialogflow:v2beta1/ListSessionEntityTypesResponse": list_session_entity_types_response +"/dialogflow:v2beta1/ListSessionEntityTypesResponse/nextPageToken": next_page_token +"/dialogflow:v2beta1/ListSessionEntityTypesResponse/sessionEntityTypes": session_entity_types +"/dialogflow:v2beta1/ListSessionEntityTypesResponse/sessionEntityTypes/session_entity_type": session_entity_type +"/dialogflow:v2beta1/Operation": operation +"/dialogflow:v2beta1/Operation/done": done +"/dialogflow:v2beta1/Operation/error": error +"/dialogflow:v2beta1/Operation/metadata": metadata +"/dialogflow:v2beta1/Operation/metadata/metadatum": metadatum +"/dialogflow:v2beta1/Operation/name": name +"/dialogflow:v2beta1/Operation/response": response +"/dialogflow:v2beta1/Operation/response/response": response +"/dialogflow:v2beta1/OriginalDetectIntentRequest": original_detect_intent_request +"/dialogflow:v2beta1/OriginalDetectIntentRequest/payload": payload +"/dialogflow:v2beta1/OriginalDetectIntentRequest/payload/payload": payload +"/dialogflow:v2beta1/OriginalDetectIntentRequest/source": source +"/dialogflow:v2beta1/QueryInput": query_input +"/dialogflow:v2beta1/QueryInput/audioConfig": audio_config +"/dialogflow:v2beta1/QueryInput/event": event +"/dialogflow:v2beta1/QueryInput/text": text +"/dialogflow:v2beta1/QueryParameters": query_parameters +"/dialogflow:v2beta1/QueryParameters/contexts": contexts +"/dialogflow:v2beta1/QueryParameters/contexts/context": context +"/dialogflow:v2beta1/QueryParameters/geoLocation": geo_location +"/dialogflow:v2beta1/QueryParameters/payload": payload +"/dialogflow:v2beta1/QueryParameters/payload/payload": payload +"/dialogflow:v2beta1/QueryParameters/resetContexts": reset_contexts +"/dialogflow:v2beta1/QueryParameters/sessionEntityTypes": session_entity_types +"/dialogflow:v2beta1/QueryParameters/sessionEntityTypes/session_entity_type": session_entity_type +"/dialogflow:v2beta1/QueryParameters/timeZone": time_zone +"/dialogflow:v2beta1/QueryResult": query_result +"/dialogflow:v2beta1/QueryResult/action": action +"/dialogflow:v2beta1/QueryResult/allRequiredParamsPresent": all_required_params_present +"/dialogflow:v2beta1/QueryResult/diagnosticInfo": diagnostic_info +"/dialogflow:v2beta1/QueryResult/diagnosticInfo/diagnostic_info": diagnostic_info +"/dialogflow:v2beta1/QueryResult/fulfillmentMessages": fulfillment_messages +"/dialogflow:v2beta1/QueryResult/fulfillmentMessages/fulfillment_message": fulfillment_message +"/dialogflow:v2beta1/QueryResult/fulfillmentText": fulfillment_text +"/dialogflow:v2beta1/QueryResult/intent": intent +"/dialogflow:v2beta1/QueryResult/intentDetectionConfidence": intent_detection_confidence +"/dialogflow:v2beta1/QueryResult/languageCode": language_code +"/dialogflow:v2beta1/QueryResult/outputContexts": output_contexts +"/dialogflow:v2beta1/QueryResult/outputContexts/output_context": output_context +"/dialogflow:v2beta1/QueryResult/parameters": parameters +"/dialogflow:v2beta1/QueryResult/parameters/parameter": parameter +"/dialogflow:v2beta1/QueryResult/queryText": query_text +"/dialogflow:v2beta1/QueryResult/speechRecognitionConfidence": speech_recognition_confidence +"/dialogflow:v2beta1/QueryResult/webhookPayload": webhook_payload +"/dialogflow:v2beta1/QueryResult/webhookPayload/webhook_payload": webhook_payload +"/dialogflow:v2beta1/QueryResult/webhookSource": webhook_source +"/dialogflow:v2beta1/RestoreAgentRequest": restore_agent_request +"/dialogflow:v2beta1/RestoreAgentRequest/agentContent": agent_content +"/dialogflow:v2beta1/RestoreAgentRequest/agentUri": agent_uri +"/dialogflow:v2beta1/SearchAgentsResponse": search_agents_response +"/dialogflow:v2beta1/SearchAgentsResponse/agents": agents +"/dialogflow:v2beta1/SearchAgentsResponse/agents/agent": agent +"/dialogflow:v2beta1/SearchAgentsResponse/nextPageToken": next_page_token +"/dialogflow:v2beta1/SessionEntityType": session_entity_type +"/dialogflow:v2beta1/SessionEntityType/entities": entities +"/dialogflow:v2beta1/SessionEntityType/entities/entity": entity +"/dialogflow:v2beta1/SessionEntityType/entityOverrideMode": entity_override_mode +"/dialogflow:v2beta1/SessionEntityType/name": name +"/dialogflow:v2beta1/Status": status +"/dialogflow:v2beta1/Status/code": code +"/dialogflow:v2beta1/Status/details": details +"/dialogflow:v2beta1/Status/details/detail": detail +"/dialogflow:v2beta1/Status/details/detail/detail": detail +"/dialogflow:v2beta1/Status/message": message +"/dialogflow:v2beta1/TextInput": text_input +"/dialogflow:v2beta1/TextInput/languageCode": language_code +"/dialogflow:v2beta1/TextInput/text": text +"/dialogflow:v2beta1/TrainAgentRequest": train_agent_request +"/dialogflow:v2beta1/WebhookRequest": webhook_request +"/dialogflow:v2beta1/WebhookRequest/originalDetectIntentRequest": original_detect_intent_request +"/dialogflow:v2beta1/WebhookRequest/queryResult": query_result +"/dialogflow:v2beta1/WebhookRequest/responseId": response_id +"/dialogflow:v2beta1/WebhookRequest/session": session +"/dialogflow:v2beta1/WebhookResponse": webhook_response +"/dialogflow:v2beta1/WebhookResponse/followupEventInput": followup_event_input +"/dialogflow:v2beta1/WebhookResponse/fulfillmentMessages": fulfillment_messages +"/dialogflow:v2beta1/WebhookResponse/fulfillmentMessages/fulfillment_message": fulfillment_message +"/dialogflow:v2beta1/WebhookResponse/fulfillmentText": fulfillment_text +"/dialogflow:v2beta1/WebhookResponse/outputContexts": output_contexts +"/dialogflow:v2beta1/WebhookResponse/outputContexts/output_context": output_context +"/dialogflow:v2beta1/WebhookResponse/payload": payload +"/dialogflow:v2beta1/WebhookResponse/payload/payload": payload +"/dialogflow:v2beta1/WebhookResponse/source": source +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.batchDelete": batch_delete_entity_types +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.batchDelete/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.batchUpdate": batch_update_entity_types +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.batchUpdate/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.create": create_project_agent_entity_type +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.create/languageCode": language_code +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.create/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.delete": delete_project_agent_entity_type +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.delete/name": name +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.entities.batchCreate": batch_entity_create_entities +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.entities.batchCreate/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.entities.batchDelete": batch_entity_delete_entities +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.entities.batchDelete/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.entities.batchUpdate": batch_entity_update_entities +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.entities.batchUpdate/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.get": get_project_agent_entity_type +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.get/languageCode": language_code +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.get/name": name +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.list": list_project_agent_entity_types +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.list/languageCode": language_code +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.list/pageSize": page_size +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.list/pageToken": page_token +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.list/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.patch": patch_project_agent_entity_type +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.patch/languageCode": language_code +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.patch/name": name +"/dialogflow:v2beta1/dialogflow.projects.agent.entityTypes.patch/updateMask": update_mask +"/dialogflow:v2beta1/dialogflow.projects.agent.export": export_agent +"/dialogflow:v2beta1/dialogflow.projects.agent.export/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.import": import_agent +"/dialogflow:v2beta1/dialogflow.projects.agent.import/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.batchDelete": batch_delete_intents +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.batchDelete/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.batchUpdate": batch_update_intents +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.batchUpdate/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.create": create_project_agent_intent +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.create/intentView": intent_view +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.create/languageCode": language_code +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.create/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.delete": delete_project_agent_intent +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.delete/name": name +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.get": get_project_agent_intent +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.get/intentView": intent_view +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.get/languageCode": language_code +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.get/name": name +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.list": list_project_agent_intents +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.list/intentView": intent_view +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.list/languageCode": language_code +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.list/pageSize": page_size +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.list/pageToken": page_token +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.list/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.patch": patch_project_agent_intent +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.patch/intentView": intent_view +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.patch/languageCode": language_code +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.patch/name": name +"/dialogflow:v2beta1/dialogflow.projects.agent.intents.patch/updateMask": update_mask +"/dialogflow:v2beta1/dialogflow.projects.agent.restore": restore_agent +"/dialogflow:v2beta1/dialogflow.projects.agent.restore/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.search": search_project_agents +"/dialogflow:v2beta1/dialogflow.projects.agent.search/pageSize": page_size +"/dialogflow:v2beta1/dialogflow.projects.agent.search/pageToken": page_token +"/dialogflow:v2beta1/dialogflow.projects.agent.search/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.contexts.create": create_project_agent_session_context +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.contexts.create/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.contexts.delete": delete_project_agent_session_context +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.contexts.delete/name": name +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.contexts.get": get_project_agent_session_context +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.contexts.get/name": name +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.contexts.list": list_project_agent_session_contexts +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.contexts.list/pageSize": page_size +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.contexts.list/pageToken": page_token +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.contexts.list/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.contexts.patch": patch_project_agent_session_context +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.contexts.patch/name": name +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.contexts.patch/updateMask": update_mask +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.deleteContexts": delete_project_agent_session_contexts +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.deleteContexts/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.detectIntent": detect_session_intent +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.detectIntent/session": session +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.entityTypes.create": create_project_agent_session_entity_type +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.entityTypes.create/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.entityTypes.delete": delete_project_agent_session_entity_type +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.entityTypes.delete/name": name +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.entityTypes.get": get_project_agent_session_entity_type +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.entityTypes.get/name": name +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.entityTypes.list": list_project_agent_session_entity_types +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.entityTypes.list/pageSize": page_size +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.entityTypes.list/pageToken": page_token +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.entityTypes.list/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.entityTypes.patch": patch_project_agent_session_entity_type +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.entityTypes.patch/name": name +"/dialogflow:v2beta1/dialogflow.projects.agent.sessions.entityTypes.patch/updateMask": update_mask +"/dialogflow:v2beta1/dialogflow.projects.agent.train": train_agent +"/dialogflow:v2beta1/dialogflow.projects.agent.train/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.getAgent": get_project_agent +"/dialogflow:v2beta1/dialogflow.projects.getAgent/parent": parent +"/dialogflow:v2beta1/dialogflow.projects.operations.get": get_project_operation +"/dialogflow:v2beta1/dialogflow.projects.operations.get/name": name +"/dialogflow:v2beta1/fields": fields +"/dialogflow:v2beta1/key": key +"/dialogflow:v2beta1/quotaUser": quota_user "/discovery:v1/DirectoryList": directory_list "/discovery:v1/DirectoryList/discoveryVersion": discovery_version "/discovery:v1/DirectoryList/items": items @@ -38907,6 +42799,11 @@ "/dlp:v2beta1/GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest": google_privacy_dlp_v2beta1_analyze_data_source_risk_request "/dlp:v2beta1/GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest/privacyMetric": privacy_metric "/dlp:v2beta1/GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest/sourceTable": source_table +"/dlp:v2beta1/GooglePrivacyDlpV2beta1AuxiliaryTable": google_privacy_dlp_v2beta1_auxiliary_table +"/dlp:v2beta1/GooglePrivacyDlpV2beta1AuxiliaryTable/quasiIds": quasi_ids +"/dlp:v2beta1/GooglePrivacyDlpV2beta1AuxiliaryTable/quasiIds/quasi_id": quasi_id +"/dlp:v2beta1/GooglePrivacyDlpV2beta1AuxiliaryTable/relativeFrequency": relative_frequency +"/dlp:v2beta1/GooglePrivacyDlpV2beta1AuxiliaryTable/table": table "/dlp:v2beta1/GooglePrivacyDlpV2beta1BigQueryOptions": google_privacy_dlp_v2beta1_big_query_options "/dlp:v2beta1/GooglePrivacyDlpV2beta1BigQueryOptions/identifyingFields": identifying_fields "/dlp:v2beta1/GooglePrivacyDlpV2beta1BigQueryOptions/identifyingFields/identifying_field": identifying_field @@ -38989,6 +42886,9 @@ "/dlp:v2beta1/GooglePrivacyDlpV2beta1CryptoReplaceRegexFpeConfig/context": context "/dlp:v2beta1/GooglePrivacyDlpV2beta1CryptoReplaceRegexFpeConfig/cryptoKey": crypto_key "/dlp:v2beta1/GooglePrivacyDlpV2beta1CryptoReplaceRegexFpeConfig/regex": regex +"/dlp:v2beta1/GooglePrivacyDlpV2beta1CustomInfoType": google_privacy_dlp_v2beta1_custom_info_type +"/dlp:v2beta1/GooglePrivacyDlpV2beta1CustomInfoType/dictionary": dictionary +"/dlp:v2beta1/GooglePrivacyDlpV2beta1CustomInfoType/infoType": info_type "/dlp:v2beta1/GooglePrivacyDlpV2beta1DatastoreKey": google_privacy_dlp_v2beta1_datastore_key "/dlp:v2beta1/GooglePrivacyDlpV2beta1DatastoreKey/entityKey": entity_key "/dlp:v2beta1/GooglePrivacyDlpV2beta1DatastoreOptions": google_privacy_dlp_v2beta1_datastore_options @@ -39013,6 +42913,8 @@ "/dlp:v2beta1/GooglePrivacyDlpV2beta1DeidentifyContentResponse/items/item": item "/dlp:v2beta1/GooglePrivacyDlpV2beta1DeidentifyContentResponse/summaries": summaries "/dlp:v2beta1/GooglePrivacyDlpV2beta1DeidentifyContentResponse/summaries/summary": summary +"/dlp:v2beta1/GooglePrivacyDlpV2beta1Dictionary": google_privacy_dlp_v2beta1_dictionary +"/dlp:v2beta1/GooglePrivacyDlpV2beta1Dictionary/wordList": word_list "/dlp:v2beta1/GooglePrivacyDlpV2beta1EntityId": google_privacy_dlp_v2beta1_entity_id "/dlp:v2beta1/GooglePrivacyDlpV2beta1EntityId/field": field "/dlp:v2beta1/GooglePrivacyDlpV2beta1Expressions": google_privacy_dlp_v2beta1_expressions @@ -39068,6 +42970,8 @@ "/dlp:v2beta1/GooglePrivacyDlpV2beta1InfoTypeTransformations/transformations": transformations "/dlp:v2beta1/GooglePrivacyDlpV2beta1InfoTypeTransformations/transformations/transformation": transformation "/dlp:v2beta1/GooglePrivacyDlpV2beta1InspectConfig": google_privacy_dlp_v2beta1_inspect_config +"/dlp:v2beta1/GooglePrivacyDlpV2beta1InspectConfig/customInfoTypes": custom_info_types +"/dlp:v2beta1/GooglePrivacyDlpV2beta1InspectConfig/customInfoTypes/custom_info_type": custom_info_type "/dlp:v2beta1/GooglePrivacyDlpV2beta1InspectConfig/excludeTypes": exclude_types "/dlp:v2beta1/GooglePrivacyDlpV2beta1InspectConfig/includeQuote": include_quote "/dlp:v2beta1/GooglePrivacyDlpV2beta1InspectConfig/infoTypeLimits": info_type_limits @@ -39115,6 +43019,25 @@ "/dlp:v2beta1/GooglePrivacyDlpV2beta1KAnonymityResult": google_privacy_dlp_v2beta1_k_anonymity_result "/dlp:v2beta1/GooglePrivacyDlpV2beta1KAnonymityResult/equivalenceClassHistogramBuckets": equivalence_class_histogram_buckets "/dlp:v2beta1/GooglePrivacyDlpV2beta1KAnonymityResult/equivalenceClassHistogramBuckets/equivalence_class_histogram_bucket": equivalence_class_histogram_bucket +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationConfig": google_privacy_dlp_v2beta1_k_map_estimation_config +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationConfig/auxiliaryTables": auxiliary_tables +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationConfig/auxiliaryTables/auxiliary_table": auxiliary_table +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationConfig/quasiIds": quasi_ids +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationConfig/quasiIds/quasi_id": quasi_id +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationConfig/regionCode": region_code +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket": google_privacy_dlp_v2beta1_k_map_estimation_histogram_bucket +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket/bucketSize": bucket_size +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket/bucketValues": bucket_values +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket/bucketValues/bucket_value": bucket_value +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket/maxAnonymity": max_anonymity +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket/minAnonymity": min_anonymity +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues": google_privacy_dlp_v2beta1_k_map_estimation_quasi_id_values +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues/estimatedAnonymity": estimated_anonymity +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues/quasiIdsValues": quasi_ids_values +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues/quasiIdsValues/quasi_ids_value": quasi_ids_value +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationResult": google_privacy_dlp_v2beta1_k_map_estimation_result +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationResult/kMapEstimationHistogram": k_map_estimation_histogram +"/dlp:v2beta1/GooglePrivacyDlpV2beta1KMapEstimationResult/kMapEstimationHistogram/k_map_estimation_histogram": k_map_estimation_histogram "/dlp:v2beta1/GooglePrivacyDlpV2beta1Key": google_privacy_dlp_v2beta1_key "/dlp:v2beta1/GooglePrivacyDlpV2beta1Key/partitionId": partition_id "/dlp:v2beta1/GooglePrivacyDlpV2beta1Key/path": path @@ -39195,12 +43118,16 @@ "/dlp:v2beta1/GooglePrivacyDlpV2beta1PrivacyMetric": google_privacy_dlp_v2beta1_privacy_metric "/dlp:v2beta1/GooglePrivacyDlpV2beta1PrivacyMetric/categoricalStatsConfig": categorical_stats_config "/dlp:v2beta1/GooglePrivacyDlpV2beta1PrivacyMetric/kAnonymityConfig": k_anonymity_config +"/dlp:v2beta1/GooglePrivacyDlpV2beta1PrivacyMetric/kMapEstimationConfig": k_map_estimation_config "/dlp:v2beta1/GooglePrivacyDlpV2beta1PrivacyMetric/lDiversityConfig": l_diversity_config "/dlp:v2beta1/GooglePrivacyDlpV2beta1PrivacyMetric/numericalStatsConfig": numerical_stats_config "/dlp:v2beta1/GooglePrivacyDlpV2beta1Projection": google_privacy_dlp_v2beta1_projection "/dlp:v2beta1/GooglePrivacyDlpV2beta1Projection/property": property "/dlp:v2beta1/GooglePrivacyDlpV2beta1PropertyReference": google_privacy_dlp_v2beta1_property_reference "/dlp:v2beta1/GooglePrivacyDlpV2beta1PropertyReference/name": name +"/dlp:v2beta1/GooglePrivacyDlpV2beta1QuasiIdField": google_privacy_dlp_v2beta1_quasi_id_field +"/dlp:v2beta1/GooglePrivacyDlpV2beta1QuasiIdField/customTag": custom_tag +"/dlp:v2beta1/GooglePrivacyDlpV2beta1QuasiIdField/field": field "/dlp:v2beta1/GooglePrivacyDlpV2beta1Range": google_privacy_dlp_v2beta1_range "/dlp:v2beta1/GooglePrivacyDlpV2beta1Range/end": end "/dlp:v2beta1/GooglePrivacyDlpV2beta1Range/start": start @@ -39241,6 +43168,7 @@ "/dlp:v2beta1/GooglePrivacyDlpV2beta1RiskAnalysisOperationResult": google_privacy_dlp_v2beta1_risk_analysis_operation_result "/dlp:v2beta1/GooglePrivacyDlpV2beta1RiskAnalysisOperationResult/categoricalStatsResult": categorical_stats_result "/dlp:v2beta1/GooglePrivacyDlpV2beta1RiskAnalysisOperationResult/kAnonymityResult": k_anonymity_result +"/dlp:v2beta1/GooglePrivacyDlpV2beta1RiskAnalysisOperationResult/kMapEstimationResult": k_map_estimation_result "/dlp:v2beta1/GooglePrivacyDlpV2beta1RiskAnalysisOperationResult/lDiversityResult": l_diversity_result "/dlp:v2beta1/GooglePrivacyDlpV2beta1RiskAnalysisOperationResult/numericalStatsResult": numerical_stats_result "/dlp:v2beta1/GooglePrivacyDlpV2beta1Row": google_privacy_dlp_v2beta1_row @@ -39261,6 +43189,11 @@ "/dlp:v2beta1/GooglePrivacyDlpV2beta1Table/rows/row": row "/dlp:v2beta1/GooglePrivacyDlpV2beta1TableLocation": google_privacy_dlp_v2beta1_table_location "/dlp:v2beta1/GooglePrivacyDlpV2beta1TableLocation/rowIndex": row_index +"/dlp:v2beta1/GooglePrivacyDlpV2beta1TaggedField": google_privacy_dlp_v2beta1_tagged_field +"/dlp:v2beta1/GooglePrivacyDlpV2beta1TaggedField/customTag": custom_tag +"/dlp:v2beta1/GooglePrivacyDlpV2beta1TaggedField/field": field +"/dlp:v2beta1/GooglePrivacyDlpV2beta1TaggedField/inferred": inferred +"/dlp:v2beta1/GooglePrivacyDlpV2beta1TaggedField/infoType": info_type "/dlp:v2beta1/GooglePrivacyDlpV2beta1TimePartConfig": google_privacy_dlp_v2beta1_time_part_config "/dlp:v2beta1/GooglePrivacyDlpV2beta1TimePartConfig/partToExtract": part_to_extract "/dlp:v2beta1/GooglePrivacyDlpV2beta1TransformationSummary": google_privacy_dlp_v2beta1_transformation_summary @@ -39287,6 +43220,9 @@ "/dlp:v2beta1/GooglePrivacyDlpV2beta1ValueFrequency": google_privacy_dlp_v2beta1_value_frequency "/dlp:v2beta1/GooglePrivacyDlpV2beta1ValueFrequency/count": count "/dlp:v2beta1/GooglePrivacyDlpV2beta1ValueFrequency/value": value +"/dlp:v2beta1/GooglePrivacyDlpV2beta1WordList": google_privacy_dlp_v2beta1_word_list +"/dlp:v2beta1/GooglePrivacyDlpV2beta1WordList/words": words +"/dlp:v2beta1/GooglePrivacyDlpV2beta1WordList/words/word": word "/dlp:v2beta1/GoogleProtobufEmpty": google_protobuf_empty "/dlp:v2beta1/GoogleRpcStatus": google_rpc_status "/dlp:v2beta1/GoogleRpcStatus/code": code @@ -39437,6 +43373,205 @@ "/dns:v1/key": key "/dns:v1/quotaUser": quota_user "/dns:v1/userIp": user_ip +"/dns:v1beta2/Change": change +"/dns:v1beta2/Change/additions": additions +"/dns:v1beta2/Change/additions/addition": addition +"/dns:v1beta2/Change/deletions": deletions +"/dns:v1beta2/Change/deletions/deletion": deletion +"/dns:v1beta2/Change/id": id +"/dns:v1beta2/Change/isServing": is_serving +"/dns:v1beta2/Change/kind": kind +"/dns:v1beta2/Change/startTime": start_time +"/dns:v1beta2/Change/status": status +"/dns:v1beta2/ChangesListResponse": changes_list_response +"/dns:v1beta2/ChangesListResponse/changes": changes +"/dns:v1beta2/ChangesListResponse/changes/change": change +"/dns:v1beta2/ChangesListResponse/header": header +"/dns:v1beta2/ChangesListResponse/kind": kind +"/dns:v1beta2/ChangesListResponse/nextPageToken": next_page_token +"/dns:v1beta2/DnsKey": dns_key +"/dns:v1beta2/DnsKey/algorithm": algorithm +"/dns:v1beta2/DnsKey/creationTime": creation_time +"/dns:v1beta2/DnsKey/description": description +"/dns:v1beta2/DnsKey/digests": digests +"/dns:v1beta2/DnsKey/digests/digest": digest +"/dns:v1beta2/DnsKey/id": id +"/dns:v1beta2/DnsKey/isActive": is_active +"/dns:v1beta2/DnsKey/keyLength": key_length +"/dns:v1beta2/DnsKey/keyTag": key_tag +"/dns:v1beta2/DnsKey/kind": kind +"/dns:v1beta2/DnsKey/publicKey": public_key +"/dns:v1beta2/DnsKey/type": type +"/dns:v1beta2/DnsKeyDigest": dns_key_digest +"/dns:v1beta2/DnsKeyDigest/digest": digest +"/dns:v1beta2/DnsKeyDigest/type": type +"/dns:v1beta2/DnsKeySpec": dns_key_spec +"/dns:v1beta2/DnsKeySpec/algorithm": algorithm +"/dns:v1beta2/DnsKeySpec/keyLength": key_length +"/dns:v1beta2/DnsKeySpec/keyType": key_type +"/dns:v1beta2/DnsKeySpec/kind": kind +"/dns:v1beta2/DnsKeysListResponse": dns_keys_list_response +"/dns:v1beta2/DnsKeysListResponse/dnsKeys": dns_keys +"/dns:v1beta2/DnsKeysListResponse/dnsKeys/dns_key": dns_key +"/dns:v1beta2/DnsKeysListResponse/header": header +"/dns:v1beta2/DnsKeysListResponse/kind": kind +"/dns:v1beta2/DnsKeysListResponse/nextPageToken": next_page_token +"/dns:v1beta2/ManagedZone": managed_zone +"/dns:v1beta2/ManagedZone/creationTime": creation_time +"/dns:v1beta2/ManagedZone/description": description +"/dns:v1beta2/ManagedZone/dnsName": dns_name +"/dns:v1beta2/ManagedZone/dnssecConfig": dnssec_config +"/dns:v1beta2/ManagedZone/id": id +"/dns:v1beta2/ManagedZone/kind": kind +"/dns:v1beta2/ManagedZone/name": name +"/dns:v1beta2/ManagedZone/nameServerSet": name_server_set +"/dns:v1beta2/ManagedZone/nameServers": name_servers +"/dns:v1beta2/ManagedZone/nameServers/name_server": name_server +"/dns:v1beta2/ManagedZoneDnsSecConfig": managed_zone_dns_sec_config +"/dns:v1beta2/ManagedZoneDnsSecConfig/defaultKeySpecs": default_key_specs +"/dns:v1beta2/ManagedZoneDnsSecConfig/defaultKeySpecs/default_key_spec": default_key_spec +"/dns:v1beta2/ManagedZoneDnsSecConfig/kind": kind +"/dns:v1beta2/ManagedZoneDnsSecConfig/nonExistence": non_existence +"/dns:v1beta2/ManagedZoneDnsSecConfig/state": state +"/dns:v1beta2/ManagedZoneOperationsListResponse": managed_zone_operations_list_response +"/dns:v1beta2/ManagedZoneOperationsListResponse/header": header +"/dns:v1beta2/ManagedZoneOperationsListResponse/kind": kind +"/dns:v1beta2/ManagedZoneOperationsListResponse/nextPageToken": next_page_token +"/dns:v1beta2/ManagedZoneOperationsListResponse/operations": operations +"/dns:v1beta2/ManagedZoneOperationsListResponse/operations/operation": operation +"/dns:v1beta2/ManagedZonesDeleteResponse": managed_zones_delete_response +"/dns:v1beta2/ManagedZonesDeleteResponse/header": header +"/dns:v1beta2/ManagedZonesListResponse": managed_zones_list_response +"/dns:v1beta2/ManagedZonesListResponse/header": header +"/dns:v1beta2/ManagedZonesListResponse/kind": kind +"/dns:v1beta2/ManagedZonesListResponse/managedZones": managed_zones +"/dns:v1beta2/ManagedZonesListResponse/managedZones/managed_zone": managed_zone +"/dns:v1beta2/ManagedZonesListResponse/nextPageToken": next_page_token +"/dns:v1beta2/Operation": operation +"/dns:v1beta2/Operation/dnsKeyContext": dns_key_context +"/dns:v1beta2/Operation/id": id +"/dns:v1beta2/Operation/kind": kind +"/dns:v1beta2/Operation/startTime": start_time +"/dns:v1beta2/Operation/status": status +"/dns:v1beta2/Operation/type": type +"/dns:v1beta2/Operation/user": user +"/dns:v1beta2/Operation/zoneContext": zone_context +"/dns:v1beta2/OperationDnsKeyContext": operation_dns_key_context +"/dns:v1beta2/OperationDnsKeyContext/newValue": new_value +"/dns:v1beta2/OperationDnsKeyContext/oldValue": old_value +"/dns:v1beta2/OperationManagedZoneContext": operation_managed_zone_context +"/dns:v1beta2/OperationManagedZoneContext/newValue": new_value +"/dns:v1beta2/OperationManagedZoneContext/oldValue": old_value +"/dns:v1beta2/Project": project +"/dns:v1beta2/Project/id": id +"/dns:v1beta2/Project/kind": kind +"/dns:v1beta2/Project/number": number +"/dns:v1beta2/Project/quota": quota +"/dns:v1beta2/Quota": quota +"/dns:v1beta2/Quota/dnsKeysPerManagedZone": dns_keys_per_managed_zone +"/dns:v1beta2/Quota/kind": kind +"/dns:v1beta2/Quota/managedZones": managed_zones +"/dns:v1beta2/Quota/resourceRecordsPerRrset": resource_records_per_rrset +"/dns:v1beta2/Quota/rrsetAdditionsPerChange": rrset_additions_per_change +"/dns:v1beta2/Quota/rrsetDeletionsPerChange": rrset_deletions_per_change +"/dns:v1beta2/Quota/rrsetsPerManagedZone": rrsets_per_managed_zone +"/dns:v1beta2/Quota/totalRrdataSizePerChange": total_rrdata_size_per_change +"/dns:v1beta2/Quota/whitelistedKeySpecs": whitelisted_key_specs +"/dns:v1beta2/Quota/whitelistedKeySpecs/whitelisted_key_spec": whitelisted_key_spec +"/dns:v1beta2/ResourceRecordSet": resource_record_set +"/dns:v1beta2/ResourceRecordSet/kind": kind +"/dns:v1beta2/ResourceRecordSet/name": name +"/dns:v1beta2/ResourceRecordSet/rrdatas": rrdatas +"/dns:v1beta2/ResourceRecordSet/rrdatas/rrdata": rrdata +"/dns:v1beta2/ResourceRecordSet/signatureRrdatas": signature_rrdatas +"/dns:v1beta2/ResourceRecordSet/signatureRrdatas/signature_rrdata": signature_rrdata +"/dns:v1beta2/ResourceRecordSet/ttl": ttl +"/dns:v1beta2/ResourceRecordSet/type": type +"/dns:v1beta2/ResourceRecordSetsListResponse": resource_record_sets_list_response +"/dns:v1beta2/ResourceRecordSetsListResponse/header": header +"/dns:v1beta2/ResourceRecordSetsListResponse/kind": kind +"/dns:v1beta2/ResourceRecordSetsListResponse/nextPageToken": next_page_token +"/dns:v1beta2/ResourceRecordSetsListResponse/rrsets": rrsets +"/dns:v1beta2/ResourceRecordSetsListResponse/rrsets/rrset": rrset +"/dns:v1beta2/ResponseHeader": response_header +"/dns:v1beta2/ResponseHeader/operationId": operation_id +"/dns:v1beta2/dns.changes.create": create_change +"/dns:v1beta2/dns.changes.create/clientOperationId": client_operation_id +"/dns:v1beta2/dns.changes.create/managedZone": managed_zone +"/dns:v1beta2/dns.changes.create/project": project +"/dns:v1beta2/dns.changes.get": get_change +"/dns:v1beta2/dns.changes.get/changeId": change_id +"/dns:v1beta2/dns.changes.get/clientOperationId": client_operation_id +"/dns:v1beta2/dns.changes.get/managedZone": managed_zone +"/dns:v1beta2/dns.changes.get/project": project +"/dns:v1beta2/dns.changes.list": list_changes +"/dns:v1beta2/dns.changes.list/managedZone": managed_zone +"/dns:v1beta2/dns.changes.list/maxResults": max_results +"/dns:v1beta2/dns.changes.list/pageToken": page_token +"/dns:v1beta2/dns.changes.list/project": project +"/dns:v1beta2/dns.changes.list/sortBy": sort_by +"/dns:v1beta2/dns.changes.list/sortOrder": sort_order +"/dns:v1beta2/dns.dnsKeys.get": get_dns_key +"/dns:v1beta2/dns.dnsKeys.get/clientOperationId": client_operation_id +"/dns:v1beta2/dns.dnsKeys.get/digestType": digest_type +"/dns:v1beta2/dns.dnsKeys.get/dnsKeyId": dns_key_id +"/dns:v1beta2/dns.dnsKeys.get/managedZone": managed_zone +"/dns:v1beta2/dns.dnsKeys.get/project": project +"/dns:v1beta2/dns.dnsKeys.list": list_dns_keys +"/dns:v1beta2/dns.dnsKeys.list/digestType": digest_type +"/dns:v1beta2/dns.dnsKeys.list/managedZone": managed_zone +"/dns:v1beta2/dns.dnsKeys.list/maxResults": max_results +"/dns:v1beta2/dns.dnsKeys.list/pageToken": page_token +"/dns:v1beta2/dns.dnsKeys.list/project": project +"/dns:v1beta2/dns.managedZoneOperations.get": get_managed_zone_operation +"/dns:v1beta2/dns.managedZoneOperations.get/clientOperationId": client_operation_id +"/dns:v1beta2/dns.managedZoneOperations.get/managedZone": managed_zone +"/dns:v1beta2/dns.managedZoneOperations.get/operation": operation +"/dns:v1beta2/dns.managedZoneOperations.get/project": project +"/dns:v1beta2/dns.managedZoneOperations.list": list_managed_zone_operations +"/dns:v1beta2/dns.managedZoneOperations.list/managedZone": managed_zone +"/dns:v1beta2/dns.managedZoneOperations.list/maxResults": max_results +"/dns:v1beta2/dns.managedZoneOperations.list/pageToken": page_token +"/dns:v1beta2/dns.managedZoneOperations.list/project": project +"/dns:v1beta2/dns.managedZoneOperations.list/sortBy": sort_by +"/dns:v1beta2/dns.managedZones.create": create_managed_zone +"/dns:v1beta2/dns.managedZones.create/clientOperationId": client_operation_id +"/dns:v1beta2/dns.managedZones.create/project": project +"/dns:v1beta2/dns.managedZones.delete": delete_managed_zone +"/dns:v1beta2/dns.managedZones.delete/clientOperationId": client_operation_id +"/dns:v1beta2/dns.managedZones.delete/managedZone": managed_zone +"/dns:v1beta2/dns.managedZones.delete/project": project +"/dns:v1beta2/dns.managedZones.get": get_managed_zone +"/dns:v1beta2/dns.managedZones.get/clientOperationId": client_operation_id +"/dns:v1beta2/dns.managedZones.get/managedZone": managed_zone +"/dns:v1beta2/dns.managedZones.get/project": project +"/dns:v1beta2/dns.managedZones.list": list_managed_zones +"/dns:v1beta2/dns.managedZones.list/dnsName": dns_name +"/dns:v1beta2/dns.managedZones.list/maxResults": max_results +"/dns:v1beta2/dns.managedZones.list/pageToken": page_token +"/dns:v1beta2/dns.managedZones.list/project": project +"/dns:v1beta2/dns.managedZones.patch": patch_managed_zone +"/dns:v1beta2/dns.managedZones.patch/clientOperationId": client_operation_id +"/dns:v1beta2/dns.managedZones.patch/managedZone": managed_zone +"/dns:v1beta2/dns.managedZones.patch/project": project +"/dns:v1beta2/dns.managedZones.update": update_managed_zone +"/dns:v1beta2/dns.managedZones.update/clientOperationId": client_operation_id +"/dns:v1beta2/dns.managedZones.update/managedZone": managed_zone +"/dns:v1beta2/dns.managedZones.update/project": project +"/dns:v1beta2/dns.projects.get": get_project +"/dns:v1beta2/dns.projects.get/clientOperationId": client_operation_id +"/dns:v1beta2/dns.projects.get/project": project +"/dns:v1beta2/dns.resourceRecordSets.list": list_resource_record_sets +"/dns:v1beta2/dns.resourceRecordSets.list/managedZone": managed_zone +"/dns:v1beta2/dns.resourceRecordSets.list/maxResults": max_results +"/dns:v1beta2/dns.resourceRecordSets.list/name": name +"/dns:v1beta2/dns.resourceRecordSets.list/pageToken": page_token +"/dns:v1beta2/dns.resourceRecordSets.list/project": project +"/dns:v1beta2/dns.resourceRecordSets.list/type": type +"/dns:v1beta2/fields": fields +"/dns:v1beta2/key": key +"/dns:v1beta2/quotaUser": quota_user +"/dns:v1beta2/userIp": user_ip "/dns:v2beta1/Change": change "/dns:v2beta1/Change/additions": additions "/dns:v2beta1/Change/additions/addition": addition @@ -40371,6 +44506,7 @@ "/drive:v2/TeamDrive/capabilities/canRenameTeamDrive": can_rename_team_drive "/drive:v2/TeamDrive/capabilities/canShare": can_share "/drive:v2/TeamDrive/colorRgb": color_rgb +"/drive:v2/TeamDrive/createdDate": created_date "/drive:v2/TeamDrive/id": id "/drive:v2/TeamDrive/kind": kind "/drive:v2/TeamDrive/name": name @@ -40576,10 +44712,12 @@ "/drive:v2/drive.permissions.delete/fileId": file_id "/drive:v2/drive.permissions.delete/permissionId": permission_id "/drive:v2/drive.permissions.delete/supportsTeamDrives": supports_team_drives +"/drive:v2/drive.permissions.delete/useDomainAdminAccess": use_domain_admin_access "/drive:v2/drive.permissions.get": get_permission "/drive:v2/drive.permissions.get/fileId": file_id "/drive:v2/drive.permissions.get/permissionId": permission_id "/drive:v2/drive.permissions.get/supportsTeamDrives": supports_team_drives +"/drive:v2/drive.permissions.get/useDomainAdminAccess": use_domain_admin_access "/drive:v2/drive.permissions.getIdForEmail": get_permission_id_for_email "/drive:v2/drive.permissions.getIdForEmail/email": email "/drive:v2/drive.permissions.insert": insert_permission @@ -40587,23 +44725,27 @@ "/drive:v2/drive.permissions.insert/fileId": file_id "/drive:v2/drive.permissions.insert/sendNotificationEmails": send_notification_emails "/drive:v2/drive.permissions.insert/supportsTeamDrives": supports_team_drives +"/drive:v2/drive.permissions.insert/useDomainAdminAccess": use_domain_admin_access "/drive:v2/drive.permissions.list": list_permissions "/drive:v2/drive.permissions.list/fileId": file_id "/drive:v2/drive.permissions.list/maxResults": max_results "/drive:v2/drive.permissions.list/pageToken": page_token "/drive:v2/drive.permissions.list/supportsTeamDrives": supports_team_drives +"/drive:v2/drive.permissions.list/useDomainAdminAccess": use_domain_admin_access "/drive:v2/drive.permissions.patch": patch_permission "/drive:v2/drive.permissions.patch/fileId": file_id "/drive:v2/drive.permissions.patch/permissionId": permission_id "/drive:v2/drive.permissions.patch/removeExpiration": remove_expiration "/drive:v2/drive.permissions.patch/supportsTeamDrives": supports_team_drives "/drive:v2/drive.permissions.patch/transferOwnership": transfer_ownership +"/drive:v2/drive.permissions.patch/useDomainAdminAccess": use_domain_admin_access "/drive:v2/drive.permissions.update": update_permission "/drive:v2/drive.permissions.update/fileId": file_id "/drive:v2/drive.permissions.update/permissionId": permission_id "/drive:v2/drive.permissions.update/removeExpiration": remove_expiration "/drive:v2/drive.permissions.update/supportsTeamDrives": supports_team_drives "/drive:v2/drive.permissions.update/transferOwnership": transfer_ownership +"/drive:v2/drive.permissions.update/useDomainAdminAccess": use_domain_admin_access "/drive:v2/drive.properties.delete": delete_property "/drive:v2/drive.properties.delete/fileId": file_id "/drive:v2/drive.properties.delete/propertyKey": property_key @@ -40676,11 +44818,14 @@ "/drive:v2/drive.teamdrives.delete/teamDriveId": team_drive_id "/drive:v2/drive.teamdrives.get": get_teamdrive "/drive:v2/drive.teamdrives.get/teamDriveId": team_drive_id +"/drive:v2/drive.teamdrives.get/useDomainAdminAccess": use_domain_admin_access "/drive:v2/drive.teamdrives.insert": insert_teamdrive "/drive:v2/drive.teamdrives.insert/requestId": request_id "/drive:v2/drive.teamdrives.list": list_teamdrives "/drive:v2/drive.teamdrives.list/maxResults": max_results "/drive:v2/drive.teamdrives.list/pageToken": page_token +"/drive:v2/drive.teamdrives.list/q": q +"/drive:v2/drive.teamdrives.list/useDomainAdminAccess": use_domain_admin_access "/drive:v2/drive.teamdrives.update": update_teamdrive "/drive:v2/drive.teamdrives.update/teamDriveId": team_drive_id "/drive:v2/fields": fields @@ -40961,6 +45106,7 @@ "/drive:v3/TeamDrive/capabilities/canRenameTeamDrive": can_rename_team_drive "/drive:v3/TeamDrive/capabilities/canShare": can_share "/drive:v3/TeamDrive/colorRgb": color_rgb +"/drive:v3/TeamDrive/createdTime": created_time "/drive:v3/TeamDrive/id": id "/drive:v3/TeamDrive/kind": kind "/drive:v3/TeamDrive/name": name @@ -41075,25 +45221,30 @@ "/drive:v3/drive.permissions.create/sendNotificationEmail": send_notification_email "/drive:v3/drive.permissions.create/supportsTeamDrives": supports_team_drives "/drive:v3/drive.permissions.create/transferOwnership": transfer_ownership +"/drive:v3/drive.permissions.create/useDomainAdminAccess": use_domain_admin_access "/drive:v3/drive.permissions.delete": delete_permission "/drive:v3/drive.permissions.delete/fileId": file_id "/drive:v3/drive.permissions.delete/permissionId": permission_id "/drive:v3/drive.permissions.delete/supportsTeamDrives": supports_team_drives +"/drive:v3/drive.permissions.delete/useDomainAdminAccess": use_domain_admin_access "/drive:v3/drive.permissions.get": get_permission "/drive:v3/drive.permissions.get/fileId": file_id "/drive:v3/drive.permissions.get/permissionId": permission_id "/drive:v3/drive.permissions.get/supportsTeamDrives": supports_team_drives +"/drive:v3/drive.permissions.get/useDomainAdminAccess": use_domain_admin_access "/drive:v3/drive.permissions.list": list_permissions "/drive:v3/drive.permissions.list/fileId": file_id "/drive:v3/drive.permissions.list/pageSize": page_size "/drive:v3/drive.permissions.list/pageToken": page_token "/drive:v3/drive.permissions.list/supportsTeamDrives": supports_team_drives +"/drive:v3/drive.permissions.list/useDomainAdminAccess": use_domain_admin_access "/drive:v3/drive.permissions.update": update_permission "/drive:v3/drive.permissions.update/fileId": file_id "/drive:v3/drive.permissions.update/permissionId": permission_id "/drive:v3/drive.permissions.update/removeExpiration": remove_expiration "/drive:v3/drive.permissions.update/supportsTeamDrives": supports_team_drives "/drive:v3/drive.permissions.update/transferOwnership": transfer_ownership +"/drive:v3/drive.permissions.update/useDomainAdminAccess": use_domain_admin_access "/drive:v3/drive.replies.create": create_reply "/drive:v3/drive.replies.create/commentId": comment_id "/drive:v3/drive.replies.create/fileId": file_id @@ -41136,9 +45287,12 @@ "/drive:v3/drive.teamdrives.delete/teamDriveId": team_drive_id "/drive:v3/drive.teamdrives.get": get_teamdrive "/drive:v3/drive.teamdrives.get/teamDriveId": team_drive_id +"/drive:v3/drive.teamdrives.get/useDomainAdminAccess": use_domain_admin_access "/drive:v3/drive.teamdrives.list": list_teamdrives "/drive:v3/drive.teamdrives.list/pageSize": page_size "/drive:v3/drive.teamdrives.list/pageToken": page_token +"/drive:v3/drive.teamdrives.list/q": q +"/drive:v3/drive.teamdrives.list/useDomainAdminAccess": use_domain_admin_access "/drive:v3/drive.teamdrives.update": update_teamdrive "/drive:v3/drive.teamdrives.update/teamDriveId": team_drive_id "/drive:v3/fields": fields @@ -41162,9 +45316,12 @@ "/firebasedynamiclinks:v1/CreateShortDynamicLinkResponse/shortLink": short_link "/firebasedynamiclinks:v1/CreateShortDynamicLinkResponse/warning": warning "/firebasedynamiclinks:v1/CreateShortDynamicLinkResponse/warning/warning": warning +"/firebasedynamiclinks:v1/DesktopInfo": desktop_info +"/firebasedynamiclinks:v1/DesktopInfo/desktopFallbackLink": desktop_fallback_link "/firebasedynamiclinks:v1/DeviceInfo": device_info "/firebasedynamiclinks:v1/DeviceInfo/deviceModelName": device_model_name "/firebasedynamiclinks:v1/DeviceInfo/languageCode": language_code +"/firebasedynamiclinks:v1/DeviceInfo/languageCodeRaw": language_code_raw "/firebasedynamiclinks:v1/DeviceInfo/screenResolutionHeight": screen_resolution_height "/firebasedynamiclinks:v1/DeviceInfo/screenResolutionWidth": screen_resolution_width "/firebasedynamiclinks:v1/DeviceInfo/timezone": timezone @@ -41175,6 +45332,7 @@ "/firebasedynamiclinks:v1/DynamicLinkInfo": dynamic_link_info "/firebasedynamiclinks:v1/DynamicLinkInfo/analyticsInfo": analytics_info "/firebasedynamiclinks:v1/DynamicLinkInfo/androidInfo": android_info +"/firebasedynamiclinks:v1/DynamicLinkInfo/desktopInfo": desktop_info "/firebasedynamiclinks:v1/DynamicLinkInfo/dynamicLinkDomain": dynamic_link_domain "/firebasedynamiclinks:v1/DynamicLinkInfo/iosInfo": ios_info "/firebasedynamiclinks:v1/DynamicLinkInfo/link": link @@ -41250,6 +45408,7 @@ "/firebaseremoteconfig:v1/RemoteConfig/parameters": parameters "/firebaseremoteconfig:v1/RemoteConfig/parameters/parameter": parameter "/firebaseremoteconfig:v1/RemoteConfigCondition": remote_config_condition +"/firebaseremoteconfig:v1/RemoteConfigCondition/description": description "/firebaseremoteconfig:v1/RemoteConfigCondition/expression": expression "/firebaseremoteconfig:v1/RemoteConfigCondition/name": name "/firebaseremoteconfig:v1/RemoteConfigCondition/tagColor": tag_color @@ -41257,6 +45416,7 @@ "/firebaseremoteconfig:v1/RemoteConfigParameter/conditionalValues": conditional_values "/firebaseremoteconfig:v1/RemoteConfigParameter/conditionalValues/conditional_value": conditional_value "/firebaseremoteconfig:v1/RemoteConfigParameter/defaultValue": default_value +"/firebaseremoteconfig:v1/RemoteConfigParameter/description": description "/firebaseremoteconfig:v1/RemoteConfigParameterValue": remote_config_parameter_value "/firebaseremoteconfig:v1/RemoteConfigParameterValue/useInAppDefault": use_in_app_default "/firebaseremoteconfig:v1/RemoteConfigParameterValue/value": value @@ -41346,6 +45506,9 @@ "/firebaserules:v1/TestSuite": test_suite "/firebaserules:v1/TestSuite/testCases": test_cases "/firebaserules:v1/TestSuite/testCases/test_case": test_case +"/firebaserules:v1/UpdateReleaseRequest": update_release_request +"/firebaserules:v1/UpdateReleaseRequest/release": release +"/firebaserules:v1/UpdateReleaseRequest/updateMask": update_mask "/firebaserules:v1/fields": fields "/firebaserules:v1/firebaserules.projects.releases.create": create_project_release "/firebaserules:v1/firebaserules.projects.releases.create/name": name @@ -41361,6 +45524,8 @@ "/firebaserules:v1/firebaserules.projects.releases.list/name": name "/firebaserules:v1/firebaserules.projects.releases.list/pageSize": page_size "/firebaserules:v1/firebaserules.projects.releases.list/pageToken": page_token +"/firebaserules:v1/firebaserules.projects.releases.patch": patch_project_release +"/firebaserules:v1/firebaserules.projects.releases.patch/name": name "/firebaserules:v1/firebaserules.projects.releases.update": update_project_release "/firebaserules:v1/firebaserules.projects.releases.update/name": name "/firebaserules:v1/firebaserules.projects.rulesets.create": create_project_ruleset @@ -41484,6 +45649,9 @@ "/firestore:v1beta1/LatLng": lat_lng "/firestore:v1beta1/LatLng/latitude": latitude "/firestore:v1beta1/LatLng/longitude": longitude +"/firestore:v1beta1/ListCollectionIdsRequest": list_collection_ids_request +"/firestore:v1beta1/ListCollectionIdsRequest/pageSize": page_size +"/firestore:v1beta1/ListCollectionIdsRequest/pageToken": page_token "/firestore:v1beta1/ListCollectionIdsResponse": list_collection_ids_response "/firestore:v1beta1/ListCollectionIdsResponse/collectionIds": collection_ids "/firestore:v1beta1/ListCollectionIdsResponse/collectionIds/collection_id": collection_id @@ -44127,6 +48295,8 @@ "/genomics:v1alpha2/PipelineParameter/localCopy": local_copy "/genomics:v1alpha2/PipelineParameter/name": name "/genomics:v1alpha2/PipelineResources": pipeline_resources +"/genomics:v1alpha2/PipelineResources/acceleratorCount": accelerator_count +"/genomics:v1alpha2/PipelineResources/acceleratorType": accelerator_type "/genomics:v1alpha2/PipelineResources/bootDiskSizeGb": boot_disk_size_gb "/genomics:v1alpha2/PipelineResources/disks": disks "/genomics:v1alpha2/PipelineResources/disks/disk": disk @@ -45341,6 +49511,8 @@ "/language:v1/AnnotateTextRequest/encodingType": encoding_type "/language:v1/AnnotateTextRequest/features": features "/language:v1/AnnotateTextResponse": annotate_text_response +"/language:v1/AnnotateTextResponse/categories": categories +"/language:v1/AnnotateTextResponse/categories/category": category "/language:v1/AnnotateTextResponse/documentSentiment": document_sentiment "/language:v1/AnnotateTextResponse/entities": entities "/language:v1/AnnotateTextResponse/entities/entity": entity @@ -45349,6 +49521,14 @@ "/language:v1/AnnotateTextResponse/sentences/sentence": sentence "/language:v1/AnnotateTextResponse/tokens": tokens "/language:v1/AnnotateTextResponse/tokens/token": token +"/language:v1/ClassificationCategory": classification_category +"/language:v1/ClassificationCategory/confidence": confidence +"/language:v1/ClassificationCategory/name": name +"/language:v1/ClassifyTextRequest": classify_text_request +"/language:v1/ClassifyTextRequest/document": document +"/language:v1/ClassifyTextResponse": classify_text_response +"/language:v1/ClassifyTextResponse/categories": categories +"/language:v1/ClassifyTextResponse/categories/category": category "/language:v1/DependencyEdge": dependency_edge "/language:v1/DependencyEdge/headTokenIndex": head_token_index "/language:v1/DependencyEdge/label": label @@ -45371,6 +49551,7 @@ "/language:v1/EntityMention/text": text "/language:v1/EntityMention/type": type "/language:v1/Features": features +"/language:v1/Features/classifyText": classify_text "/language:v1/Features/extractDocumentSentiment": extract_document_sentiment "/language:v1/Features/extractEntities": extract_entities "/language:v1/Features/extractEntitySentiment": extract_entity_sentiment @@ -45415,6 +49596,7 @@ "/language:v1/language.documents.analyzeSentiment": analyze_document_sentiment "/language:v1/language.documents.analyzeSyntax": analyze_document_syntax "/language:v1/language.documents.annotateText": annotate_document_text +"/language:v1/language.documents.classifyText": classify_document_text "/language:v1/quotaUser": quota_user "/language:v1beta1/AnalyzeEntitiesRequest": analyze_entities_request "/language:v1beta1/AnalyzeEntitiesRequest/document": document @@ -45790,6 +49972,7 @@ "/logging:v2/LogEntry/resource": resource "/logging:v2/LogEntry/severity": severity "/logging:v2/LogEntry/sourceLocation": source_location +"/logging:v2/LogEntry/spanId": span_id "/logging:v2/LogEntry/textPayload": text_payload "/logging:v2/LogEntry/timestamp": timestamp "/logging:v2/LogEntry/trace": trace @@ -45945,6 +50128,19 @@ "/logging:v2/logging.billingAccounts.sinks.update/updateMask": update_mask "/logging:v2/logging.entries.list": list_entry_log_entries "/logging:v2/logging.entries.write": write_entry_log_entries +"/logging:v2/logging.exclusions.create": create_exclusion +"/logging:v2/logging.exclusions.create/parent": parent +"/logging:v2/logging.exclusions.delete": delete_exclusion +"/logging:v2/logging.exclusions.delete/name": name +"/logging:v2/logging.exclusions.get": get_exclusion +"/logging:v2/logging.exclusions.get/name": name +"/logging:v2/logging.exclusions.list": list_exclusions +"/logging:v2/logging.exclusions.list/pageSize": page_size +"/logging:v2/logging.exclusions.list/pageToken": page_token +"/logging:v2/logging.exclusions.list/parent": parent +"/logging:v2/logging.exclusions.patch": patch_exclusion +"/logging:v2/logging.exclusions.patch/name": name +"/logging:v2/logging.exclusions.patch/updateMask": update_mask "/logging:v2/logging.folders.exclusions.create": create_folder_exclusion "/logging:v2/logging.folders.exclusions.create/parent": parent "/logging:v2/logging.folders.exclusions.delete": delete_folder_exclusion @@ -45983,6 +50179,12 @@ "/logging:v2/logging.folders.sinks.update/sinkName": sink_name "/logging:v2/logging.folders.sinks.update/uniqueWriterIdentity": unique_writer_identity "/logging:v2/logging.folders.sinks.update/updateMask": update_mask +"/logging:v2/logging.logs.delete": delete_log +"/logging:v2/logging.logs.delete/logName": log_name +"/logging:v2/logging.logs.list": list_logs +"/logging:v2/logging.logs.list/pageSize": page_size +"/logging:v2/logging.logs.list/pageToken": page_token +"/logging:v2/logging.logs.list/parent": parent "/logging:v2/logging.monitoredResourceDescriptors.list": list_monitored_resource_descriptors "/logging:v2/logging.monitoredResourceDescriptors.list/pageSize": page_size "/logging:v2/logging.monitoredResourceDescriptors.list/pageToken": page_token @@ -46074,6 +50276,21 @@ "/logging:v2/logging.projects.sinks.update/sinkName": sink_name "/logging:v2/logging.projects.sinks.update/uniqueWriterIdentity": unique_writer_identity "/logging:v2/logging.projects.sinks.update/updateMask": update_mask +"/logging:v2/logging.sinks.create": create_sink +"/logging:v2/logging.sinks.create/parent": parent +"/logging:v2/logging.sinks.create/uniqueWriterIdentity": unique_writer_identity +"/logging:v2/logging.sinks.delete": delete_sink +"/logging:v2/logging.sinks.delete/sinkName": sink_name +"/logging:v2/logging.sinks.get": get_sink +"/logging:v2/logging.sinks.get/sinkName": sink_name +"/logging:v2/logging.sinks.list": list_sinks +"/logging:v2/logging.sinks.list/pageSize": page_size +"/logging:v2/logging.sinks.list/pageToken": page_token +"/logging:v2/logging.sinks.list/parent": parent +"/logging:v2/logging.sinks.update": update_sink +"/logging:v2/logging.sinks.update/sinkName": sink_name +"/logging:v2/logging.sinks.update/uniqueWriterIdentity": unique_writer_identity +"/logging:v2/logging.sinks.update/updateMask": update_mask "/logging:v2/quotaUser": quota_user "/logging:v2beta1/BucketOptions": bucket_options "/logging:v2beta1/BucketOptions/explicitBuckets": explicit_buckets @@ -46155,6 +50372,7 @@ "/logging:v2beta1/LogEntry/resource": resource "/logging:v2beta1/LogEntry/severity": severity "/logging:v2beta1/LogEntry/sourceLocation": source_location +"/logging:v2beta1/LogEntry/spanId": span_id "/logging:v2beta1/LogEntry/textPayload": text_payload "/logging:v2beta1/LogEntry/timestamp": timestamp "/logging:v2beta1/LogEntry/trace": trace @@ -46367,6 +50585,7 @@ "/manufacturers:v1/Attributes/sizeType": size_type "/manufacturers:v1/Attributes/suggestedRetailPrice": suggested_retail_price "/manufacturers:v1/Attributes/targetAccountId": target_account_id +"/manufacturers:v1/Attributes/targetClientId": target_client_id "/manufacturers:v1/Attributes/theme": theme "/manufacturers:v1/Attributes/title": title "/manufacturers:v1/Attributes/videoLink": video_link @@ -46660,7 +50879,10 @@ "/ml:v1/GoogleCloudMlV1__Job/createTime": create_time "/ml:v1/GoogleCloudMlV1__Job/endTime": end_time "/ml:v1/GoogleCloudMlV1__Job/errorMessage": error_message +"/ml:v1/GoogleCloudMlV1__Job/etag": etag "/ml:v1/GoogleCloudMlV1__Job/jobId": job_id +"/ml:v1/GoogleCloudMlV1__Job/labels": labels +"/ml:v1/GoogleCloudMlV1__Job/labels/label": label "/ml:v1/GoogleCloudMlV1__Job/predictionInput": prediction_input "/ml:v1/GoogleCloudMlV1__Job/predictionOutput": prediction_output "/ml:v1/GoogleCloudMlV1__Job/startTime": start_time @@ -46684,6 +50906,9 @@ "/ml:v1/GoogleCloudMlV1__Model": google_cloud_ml_v1__model "/ml:v1/GoogleCloudMlV1__Model/defaultVersion": default_version "/ml:v1/GoogleCloudMlV1__Model/description": description +"/ml:v1/GoogleCloudMlV1__Model/etag": etag +"/ml:v1/GoogleCloudMlV1__Model/labels": labels +"/ml:v1/GoogleCloudMlV1__Model/labels/label": label "/ml:v1/GoogleCloudMlV1__Model/name": name "/ml:v1/GoogleCloudMlV1__Model/onlinePredictionLogging": online_prediction_logging "/ml:v1/GoogleCloudMlV1__Model/regions": regions @@ -46692,6 +50917,8 @@ "/ml:v1/GoogleCloudMlV1__OperationMetadata/createTime": create_time "/ml:v1/GoogleCloudMlV1__OperationMetadata/endTime": end_time "/ml:v1/GoogleCloudMlV1__OperationMetadata/isCancellationRequested": is_cancellation_requested +"/ml:v1/GoogleCloudMlV1__OperationMetadata/labels": labels +"/ml:v1/GoogleCloudMlV1__OperationMetadata/labels/label": label "/ml:v1/GoogleCloudMlV1__OperationMetadata/modelName": model_name "/ml:v1/GoogleCloudMlV1__OperationMetadata/operationType": operation_type "/ml:v1/GoogleCloudMlV1__OperationMetadata/startTime": start_time @@ -46754,7 +50981,10 @@ "/ml:v1/GoogleCloudMlV1__Version/deploymentUri": deployment_uri "/ml:v1/GoogleCloudMlV1__Version/description": description "/ml:v1/GoogleCloudMlV1__Version/errorMessage": error_message +"/ml:v1/GoogleCloudMlV1__Version/etag": etag "/ml:v1/GoogleCloudMlV1__Version/isDefault": is_default +"/ml:v1/GoogleCloudMlV1__Version/labels": labels +"/ml:v1/GoogleCloudMlV1__Version/labels/label": label "/ml:v1/GoogleCloudMlV1__Version/lastUseTime": last_use_time "/ml:v1/GoogleCloudMlV1__Version/manualScaling": manual_scaling "/ml:v1/GoogleCloudMlV1__Version/name": name @@ -46892,6 +51122,9 @@ "/ml:v1/ml.projects.jobs.list/pageSize": page_size "/ml:v1/ml.projects.jobs.list/pageToken": page_token "/ml:v1/ml.projects.jobs.list/parent": parent +"/ml:v1/ml.projects.jobs.patch": patch_project_job +"/ml:v1/ml.projects.jobs.patch/name": name +"/ml:v1/ml.projects.jobs.patch/updateMask": update_mask "/ml:v1/ml.projects.jobs.setIamPolicy": set_project_job_iam_policy "/ml:v1/ml.projects.jobs.setIamPolicy/resource": resource "/ml:v1/ml.projects.jobs.testIamPermissions": test_project_job_iam_permissions @@ -46905,6 +51138,7 @@ "/ml:v1/ml.projects.models.getIamPolicy": get_project_model_iam_policy "/ml:v1/ml.projects.models.getIamPolicy/resource": resource "/ml:v1/ml.projects.models.list": list_project_models +"/ml:v1/ml.projects.models.list/filter": filter "/ml:v1/ml.projects.models.list/pageSize": page_size "/ml:v1/ml.projects.models.list/pageToken": page_token "/ml:v1/ml.projects.models.list/parent": parent @@ -46922,6 +51156,7 @@ "/ml:v1/ml.projects.models.versions.get": get_project_model_version "/ml:v1/ml.projects.models.versions.get/name": name "/ml:v1/ml.projects.models.versions.list": list_project_model_versions +"/ml:v1/ml.projects.models.versions.list/filter": filter "/ml:v1/ml.projects.models.versions.list/pageSize": page_size "/ml:v1/ml.projects.models.versions.list/pageToken": page_token "/ml:v1/ml.projects.models.versions.list/parent": parent @@ -47254,6 +51489,9 @@ "/ml:v1beta1/ml.projects.predict": predict_project "/ml:v1beta1/ml.projects.predict/name": name "/ml:v1beta1/quotaUser": quota_user +"/monitoring:v3/BasicAuthentication": basic_authentication +"/monitoring:v3/BasicAuthentication/password": password +"/monitoring:v3/BasicAuthentication/username": username "/monitoring:v3/BucketOptions": bucket_options "/monitoring:v3/BucketOptions/explicitBuckets": explicit_buckets "/monitoring:v3/BucketOptions/exponentialBuckets": exponential_buckets @@ -47281,6 +51519,8 @@ "/monitoring:v3/CollectdValueError": collectd_value_error "/monitoring:v3/CollectdValueError/error": error "/monitoring:v3/CollectdValueError/index": index +"/monitoring:v3/ContentMatcher": content_matcher +"/monitoring:v3/ContentMatcher/content": content "/monitoring:v3/CreateCollectdTimeSeriesRequest": create_collectd_time_series_request "/monitoring:v3/CreateCollectdTimeSeriesRequest/collectdPayloads": collectd_payloads "/monitoring:v3/CreateCollectdTimeSeriesRequest/collectdPayloads/collectd_payload": collectd_payload @@ -47326,6 +51566,20 @@ "/monitoring:v3/Group/isCluster": is_cluster "/monitoring:v3/Group/name": name "/monitoring:v3/Group/parentName": parent_name +"/monitoring:v3/HttpCheck": http_check +"/monitoring:v3/HttpCheck/authInfo": auth_info +"/monitoring:v3/HttpCheck/headers": headers +"/monitoring:v3/HttpCheck/headers/header": header +"/monitoring:v3/HttpCheck/maskHeaders": mask_headers +"/monitoring:v3/HttpCheck/path": path +"/monitoring:v3/HttpCheck/port": port +"/monitoring:v3/HttpCheck/useSsl": use_ssl +"/monitoring:v3/InternalChecker": internal_checker +"/monitoring:v3/InternalChecker/checkerId": checker_id +"/monitoring:v3/InternalChecker/displayName": display_name +"/monitoring:v3/InternalChecker/gcpZone": gcp_zone +"/monitoring:v3/InternalChecker/network": network +"/monitoring:v3/InternalChecker/projectId": project_id "/monitoring:v3/LabelDescriptor": label_descriptor "/monitoring:v3/LabelDescriptor/description": description "/monitoring:v3/LabelDescriptor/key": key @@ -47355,6 +51609,14 @@ "/monitoring:v3/ListTimeSeriesResponse/nextPageToken": next_page_token "/monitoring:v3/ListTimeSeriesResponse/timeSeries": time_series "/monitoring:v3/ListTimeSeriesResponse/timeSeries/time_series": time_series +"/monitoring:v3/ListUptimeCheckConfigsResponse": list_uptime_check_configs_response +"/monitoring:v3/ListUptimeCheckConfigsResponse/nextPageToken": next_page_token +"/monitoring:v3/ListUptimeCheckConfigsResponse/uptimeCheckConfigs": uptime_check_configs +"/monitoring:v3/ListUptimeCheckConfigsResponse/uptimeCheckConfigs/uptime_check_config": uptime_check_config +"/monitoring:v3/ListUptimeCheckIpsResponse": list_uptime_check_ips_response +"/monitoring:v3/ListUptimeCheckIpsResponse/nextPageToken": next_page_token +"/monitoring:v3/ListUptimeCheckIpsResponse/uptimeCheckIps": uptime_check_ips +"/monitoring:v3/ListUptimeCheckIpsResponse/uptimeCheckIps/uptime_check_ip": uptime_check_ip "/monitoring:v3/Metric": metric "/monitoring:v3/Metric/labels": labels "/monitoring:v3/Metric/labels/label": label @@ -47390,6 +51652,9 @@ "/monitoring:v3/Range": range "/monitoring:v3/Range/max": max "/monitoring:v3/Range/min": min +"/monitoring:v3/ResourceGroup": resource_group +"/monitoring:v3/ResourceGroup/groupId": group_id +"/monitoring:v3/ResourceGroup/resourceType": resource_type "/monitoring:v3/SourceContext": source_context "/monitoring:v3/SourceContext/fileName": file_name "/monitoring:v3/Status": status @@ -47398,6 +51663,8 @@ "/monitoring:v3/Status/details/detail": detail "/monitoring:v3/Status/details/detail/detail": detail "/monitoring:v3/Status/message": message +"/monitoring:v3/TcpCheck": tcp_check +"/monitoring:v3/TcpCheck/port": port "/monitoring:v3/TimeInterval": time_interval "/monitoring:v3/TimeInterval/endTime": end_time "/monitoring:v3/TimeInterval/startTime": start_time @@ -47424,6 +51691,25 @@ "/monitoring:v3/TypedValue/doubleValue": double_value "/monitoring:v3/TypedValue/int64Value": int64_value "/monitoring:v3/TypedValue/stringValue": string_value +"/monitoring:v3/UptimeCheckConfig": uptime_check_config +"/monitoring:v3/UptimeCheckConfig/contentMatchers": content_matchers +"/monitoring:v3/UptimeCheckConfig/contentMatchers/content_matcher": content_matcher +"/monitoring:v3/UptimeCheckConfig/displayName": display_name +"/monitoring:v3/UptimeCheckConfig/httpCheck": http_check +"/monitoring:v3/UptimeCheckConfig/internalCheckers": internal_checkers +"/monitoring:v3/UptimeCheckConfig/internalCheckers/internal_checker": internal_checker +"/monitoring:v3/UptimeCheckConfig/monitoredResource": monitored_resource +"/monitoring:v3/UptimeCheckConfig/name": name +"/monitoring:v3/UptimeCheckConfig/period": period +"/monitoring:v3/UptimeCheckConfig/resourceGroup": resource_group +"/monitoring:v3/UptimeCheckConfig/selectedRegions": selected_regions +"/monitoring:v3/UptimeCheckConfig/selectedRegions/selected_region": selected_region +"/monitoring:v3/UptimeCheckConfig/tcpCheck": tcp_check +"/monitoring:v3/UptimeCheckConfig/timeout": timeout +"/monitoring:v3/UptimeCheckIp": uptime_check_ip +"/monitoring:v3/UptimeCheckIp/ipAddress": ip_address +"/monitoring:v3/UptimeCheckIp/location": location +"/monitoring:v3/UptimeCheckIp/region": region "/monitoring:v3/fields": fields "/monitoring:v3/key": key "/monitoring:v3/monitoring.projects.collectdTimeSeries.create": create_collectd_time_series @@ -47485,6 +51771,24 @@ "/monitoring:v3/monitoring.projects.timeSeries.list/pageSize": page_size "/monitoring:v3/monitoring.projects.timeSeries.list/pageToken": page_token "/monitoring:v3/monitoring.projects.timeSeries.list/view": view +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.create": create_project_uptime_check_config +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.create/parent": parent +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.delete": delete_project_uptime_check_config +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.delete/name": name +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.get": get_project_uptime_check_config +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.get/name": name +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.list": list_project_uptime_check_configs +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.list/filter": filter +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.list/pageSize": page_size +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.list/pageToken": page_token +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.list/parent": parent +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.patch": patch_project_uptime_check_config +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.patch/name": name +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.patch/name1": name1 +"/monitoring:v3/monitoring.projects.uptimeCheckConfigs.patch/updateMask": update_mask +"/monitoring:v3/monitoring.uptimeCheckIps.list": list_uptime_check_ips +"/monitoring:v3/monitoring.uptimeCheckIps.list/pageSize": page_size +"/monitoring:v3/monitoring.uptimeCheckIps.list/pageToken": page_token "/monitoring:v3/quotaUser": quota_user "/mybusiness:v3/Account": account "/mybusiness:v3/Account/accountName": account_name @@ -47865,6 +52169,47 @@ "/oauth2:v2/oauth2.userinfo.v2.me.get": get_userinfo_v2 "/oauth2:v2/quotaUser": quota_user "/oauth2:v2/userIp": user_ip +"/oslogin:v1/Empty": empty +"/oslogin:v1/ImportSshPublicKeyResponse": import_ssh_public_key_response +"/oslogin:v1/ImportSshPublicKeyResponse/loginProfile": login_profile +"/oslogin:v1/LoginProfile": login_profile +"/oslogin:v1/LoginProfile/name": name +"/oslogin:v1/LoginProfile/posixAccounts": posix_accounts +"/oslogin:v1/LoginProfile/posixAccounts/posix_account": posix_account +"/oslogin:v1/LoginProfile/sshPublicKeys": ssh_public_keys +"/oslogin:v1/LoginProfile/sshPublicKeys/ssh_public_key": ssh_public_key +"/oslogin:v1/LoginProfile/suspended": suspended +"/oslogin:v1/PosixAccount": posix_account +"/oslogin:v1/PosixAccount/accountId": account_id +"/oslogin:v1/PosixAccount/gecos": gecos +"/oslogin:v1/PosixAccount/gid": gid +"/oslogin:v1/PosixAccount/homeDirectory": home_directory +"/oslogin:v1/PosixAccount/primary": primary +"/oslogin:v1/PosixAccount/shell": shell +"/oslogin:v1/PosixAccount/systemId": system_id +"/oslogin:v1/PosixAccount/uid": uid +"/oslogin:v1/PosixAccount/username": username +"/oslogin:v1/SshPublicKey": ssh_public_key +"/oslogin:v1/SshPublicKey/expirationTimeUsec": expiration_time_usec +"/oslogin:v1/SshPublicKey/fingerprint": fingerprint +"/oslogin:v1/SshPublicKey/key": key +"/oslogin:v1/fields": fields +"/oslogin:v1/key": key +"/oslogin:v1/oslogin.users.getLoginProfile": get_user_login_profile +"/oslogin:v1/oslogin.users.getLoginProfile/name": name +"/oslogin:v1/oslogin.users.importSshPublicKey": import_user_ssh_public_key +"/oslogin:v1/oslogin.users.importSshPublicKey/parent": parent +"/oslogin:v1/oslogin.users.importSshPublicKey/projectId": project_id +"/oslogin:v1/oslogin.users.projects.delete": delete_user_project +"/oslogin:v1/oslogin.users.projects.delete/name": name +"/oslogin:v1/oslogin.users.sshPublicKeys.delete": delete_user_ssh_public_key +"/oslogin:v1/oslogin.users.sshPublicKeys.delete/name": name +"/oslogin:v1/oslogin.users.sshPublicKeys.get": get_user_ssh_public_key +"/oslogin:v1/oslogin.users.sshPublicKeys.get/name": name +"/oslogin:v1/oslogin.users.sshPublicKeys.patch": patch_user_ssh_public_key +"/oslogin:v1/oslogin.users.sshPublicKeys.patch/name": name +"/oslogin:v1/oslogin.users.sshPublicKeys.patch/updateMask": update_mask +"/oslogin:v1/quotaUser": quota_user "/oslogin:v1alpha/Empty": empty "/oslogin:v1alpha/ImportSshPublicKeyResponse": import_ssh_public_key_response "/oslogin:v1alpha/ImportSshPublicKeyResponse/loginProfile": login_profile @@ -47876,6 +52221,7 @@ "/oslogin:v1alpha/LoginProfile/sshPublicKeys/ssh_public_key": ssh_public_key "/oslogin:v1alpha/LoginProfile/suspended": suspended "/oslogin:v1alpha/PosixAccount": posix_account +"/oslogin:v1alpha/PosixAccount/accountId": account_id "/oslogin:v1alpha/PosixAccount/gecos": gecos "/oslogin:v1alpha/PosixAccount/gid": gid "/oslogin:v1alpha/PosixAccount/homeDirectory": home_directory @@ -47894,6 +52240,9 @@ "/oslogin:v1alpha/oslogin.users.getLoginProfile/name": name "/oslogin:v1alpha/oslogin.users.importSshPublicKey": import_user_ssh_public_key "/oslogin:v1alpha/oslogin.users.importSshPublicKey/parent": parent +"/oslogin:v1alpha/oslogin.users.importSshPublicKey/projectId": project_id +"/oslogin:v1alpha/oslogin.users.projects.delete": delete_user_project +"/oslogin:v1alpha/oslogin.users.projects.delete/name": name "/oslogin:v1alpha/oslogin.users.sshPublicKeys.delete": delete_user_ssh_public_key "/oslogin:v1alpha/oslogin.users.sshPublicKeys.delete/name": name "/oslogin:v1alpha/oslogin.users.sshPublicKeys.get": get_user_ssh_public_key @@ -47913,6 +52262,7 @@ "/oslogin:v1beta/LoginProfile/sshPublicKeys/ssh_public_key": ssh_public_key "/oslogin:v1beta/LoginProfile/suspended": suspended "/oslogin:v1beta/PosixAccount": posix_account +"/oslogin:v1beta/PosixAccount/accountId": account_id "/oslogin:v1beta/PosixAccount/gecos": gecos "/oslogin:v1beta/PosixAccount/gid": gid "/oslogin:v1beta/PosixAccount/homeDirectory": home_directory @@ -47931,6 +52281,9 @@ "/oslogin:v1beta/oslogin.users.getLoginProfile/name": name "/oslogin:v1beta/oslogin.users.importSshPublicKey": import_user_ssh_public_key "/oslogin:v1beta/oslogin.users.importSshPublicKey/parent": parent +"/oslogin:v1beta/oslogin.users.importSshPublicKey/projectId": project_id +"/oslogin:v1beta/oslogin.users.projects.delete": delete_user_project +"/oslogin:v1beta/oslogin.users.projects.delete/name": name "/oslogin:v1beta/oslogin.users.sshPublicKeys.delete": delete_user_ssh_public_key "/oslogin:v1beta/oslogin.users.sshPublicKeys.delete/name": name "/oslogin:v1beta/oslogin.users.sshPublicKeys.get": get_user_ssh_public_key @@ -48424,6 +52777,7 @@ "/partners:v2/UserProfile/languages/language": language "/partners:v2/UserProfile/markets": markets "/partners:v2/UserProfile/markets/market": market +"/partners:v2/UserProfile/migrateToAfa": migrate_to_afa "/partners:v2/UserProfile/phoneNumber": phone_number "/partners:v2/UserProfile/primaryCountryCode": primary_country_code "/partners:v2/UserProfile/profilePublic": profile_public @@ -50133,6 +54487,7 @@ "/proximitybeacon:v1beta1/AdvertisedId/type": type "/proximitybeacon:v1beta1/AttachmentInfo": attachment_info "/proximitybeacon:v1beta1/AttachmentInfo/data": data +"/proximitybeacon:v1beta1/AttachmentInfo/maxDistanceMeters": max_distance_meters "/proximitybeacon:v1beta1/AttachmentInfo/namespacedType": namespaced_type "/proximitybeacon:v1beta1/Beacon": beacon "/proximitybeacon:v1beta1/Beacon/advertisedId": advertised_id @@ -51992,6 +56347,438 @@ "/searchconsole:v1/key": key "/searchconsole:v1/quotaUser": quota_user "/searchconsole:v1/searchconsole.urlTestingTools.mobileFriendlyTest.run": run_mobile_friendly_test +"/serviceconsumermanagement:v1/AddTenantProjectRequest": add_tenant_project_request +"/serviceconsumermanagement:v1/AddTenantProjectRequest/projectConfig": project_config +"/serviceconsumermanagement:v1/AddTenantProjectRequest/tag": tag +"/serviceconsumermanagement:v1/Api": api +"/serviceconsumermanagement:v1/Api/methods": methods_prop +"/serviceconsumermanagement:v1/Api/methods/methods_prop": methods_prop +"/serviceconsumermanagement:v1/Api/mixins": mixins +"/serviceconsumermanagement:v1/Api/mixins/mixin": mixin +"/serviceconsumermanagement:v1/Api/name": name +"/serviceconsumermanagement:v1/Api/options": options +"/serviceconsumermanagement:v1/Api/options/option": option +"/serviceconsumermanagement:v1/Api/sourceContext": source_context +"/serviceconsumermanagement:v1/Api/syntax": syntax +"/serviceconsumermanagement:v1/Api/version": version +"/serviceconsumermanagement:v1/AuthProvider": auth_provider +"/serviceconsumermanagement:v1/AuthProvider/audiences": audiences +"/serviceconsumermanagement:v1/AuthProvider/authorizationUrl": authorization_url +"/serviceconsumermanagement:v1/AuthProvider/id": id +"/serviceconsumermanagement:v1/AuthProvider/issuer": issuer +"/serviceconsumermanagement:v1/AuthProvider/jwksUri": jwks_uri +"/serviceconsumermanagement:v1/AuthRequirement": auth_requirement +"/serviceconsumermanagement:v1/AuthRequirement/audiences": audiences +"/serviceconsumermanagement:v1/AuthRequirement/providerId": provider_id +"/serviceconsumermanagement:v1/Authentication": authentication +"/serviceconsumermanagement:v1/Authentication/providers": providers +"/serviceconsumermanagement:v1/Authentication/providers/provider": provider +"/serviceconsumermanagement:v1/Authentication/rules": rules +"/serviceconsumermanagement:v1/Authentication/rules/rule": rule +"/serviceconsumermanagement:v1/AuthenticationRule": authentication_rule +"/serviceconsumermanagement:v1/AuthenticationRule/allowWithoutCredential": allow_without_credential +"/serviceconsumermanagement:v1/AuthenticationRule/customAuth": custom_auth +"/serviceconsumermanagement:v1/AuthenticationRule/oauth": oauth +"/serviceconsumermanagement:v1/AuthenticationRule/requirements": requirements +"/serviceconsumermanagement:v1/AuthenticationRule/requirements/requirement": requirement +"/serviceconsumermanagement:v1/AuthenticationRule/selector": selector +"/serviceconsumermanagement:v1/AuthorizationConfig": authorization_config +"/serviceconsumermanagement:v1/AuthorizationConfig/provider": provider +"/serviceconsumermanagement:v1/AuthorizationRule": authorization_rule +"/serviceconsumermanagement:v1/AuthorizationRule/permissions": permissions +"/serviceconsumermanagement:v1/AuthorizationRule/selector": selector +"/serviceconsumermanagement:v1/Backend": backend +"/serviceconsumermanagement:v1/Backend/rules": rules +"/serviceconsumermanagement:v1/Backend/rules/rule": rule +"/serviceconsumermanagement:v1/BackendRule": backend_rule +"/serviceconsumermanagement:v1/BackendRule/address": address +"/serviceconsumermanagement:v1/BackendRule/deadline": deadline +"/serviceconsumermanagement:v1/BackendRule/minDeadline": min_deadline +"/serviceconsumermanagement:v1/BackendRule/selector": selector +"/serviceconsumermanagement:v1/Billing": billing +"/serviceconsumermanagement:v1/Billing/consumerDestinations": consumer_destinations +"/serviceconsumermanagement:v1/Billing/consumerDestinations/consumer_destination": consumer_destination +"/serviceconsumermanagement:v1/BillingConfig": billing_config +"/serviceconsumermanagement:v1/BillingConfig/billingAccount": billing_account +"/serviceconsumermanagement:v1/BillingDestination": billing_destination +"/serviceconsumermanagement:v1/BillingDestination/metrics": metrics +"/serviceconsumermanagement:v1/BillingDestination/metrics/metric": metric +"/serviceconsumermanagement:v1/BillingDestination/monitoredResource": monitored_resource +"/serviceconsumermanagement:v1/CancelOperationRequest": cancel_operation_request +"/serviceconsumermanagement:v1/Context": context +"/serviceconsumermanagement:v1/Context/rules": rules +"/serviceconsumermanagement:v1/Context/rules/rule": rule +"/serviceconsumermanagement:v1/ContextRule": context_rule +"/serviceconsumermanagement:v1/ContextRule/provided": provided +"/serviceconsumermanagement:v1/ContextRule/provided/provided": provided +"/serviceconsumermanagement:v1/ContextRule/requested": requested +"/serviceconsumermanagement:v1/ContextRule/requested/requested": requested +"/serviceconsumermanagement:v1/ContextRule/selector": selector +"/serviceconsumermanagement:v1/Control": control +"/serviceconsumermanagement:v1/Control/environment": environment +"/serviceconsumermanagement:v1/CreateTenancyUnitRequest": create_tenancy_unit_request +"/serviceconsumermanagement:v1/CreateTenancyUnitRequest/tenancyUnitId": tenancy_unit_id +"/serviceconsumermanagement:v1/CustomAuthRequirements": custom_auth_requirements +"/serviceconsumermanagement:v1/CustomAuthRequirements/provider": provider +"/serviceconsumermanagement:v1/CustomError": custom_error +"/serviceconsumermanagement:v1/CustomError/rules": rules +"/serviceconsumermanagement:v1/CustomError/rules/rule": rule +"/serviceconsumermanagement:v1/CustomError/types": types +"/serviceconsumermanagement:v1/CustomError/types/type": type +"/serviceconsumermanagement:v1/CustomErrorRule": custom_error_rule +"/serviceconsumermanagement:v1/CustomErrorRule/isErrorType": is_error_type +"/serviceconsumermanagement:v1/CustomErrorRule/selector": selector +"/serviceconsumermanagement:v1/CustomHttpPattern": custom_http_pattern +"/serviceconsumermanagement:v1/CustomHttpPattern/kind": kind +"/serviceconsumermanagement:v1/CustomHttpPattern/path": path +"/serviceconsumermanagement:v1/Documentation": documentation +"/serviceconsumermanagement:v1/Documentation/documentationRootUrl": documentation_root_url +"/serviceconsumermanagement:v1/Documentation/overview": overview +"/serviceconsumermanagement:v1/Documentation/pages": pages +"/serviceconsumermanagement:v1/Documentation/pages/page": page +"/serviceconsumermanagement:v1/Documentation/rules": rules +"/serviceconsumermanagement:v1/Documentation/rules/rule": rule +"/serviceconsumermanagement:v1/Documentation/summary": summary +"/serviceconsumermanagement:v1/DocumentationRule": documentation_rule +"/serviceconsumermanagement:v1/DocumentationRule/deprecationDescription": deprecation_description +"/serviceconsumermanagement:v1/DocumentationRule/description": description +"/serviceconsumermanagement:v1/DocumentationRule/selector": selector +"/serviceconsumermanagement:v1/Empty": empty +"/serviceconsumermanagement:v1/Endpoint": endpoint +"/serviceconsumermanagement:v1/Endpoint/aliases": aliases +"/serviceconsumermanagement:v1/Endpoint/aliases/alias": alias +"/serviceconsumermanagement:v1/Endpoint/allowCors": allow_cors +"/serviceconsumermanagement:v1/Endpoint/features": features +"/serviceconsumermanagement:v1/Endpoint/features/feature": feature +"/serviceconsumermanagement:v1/Endpoint/name": name +"/serviceconsumermanagement:v1/Endpoint/target": target +"/serviceconsumermanagement:v1/Enum": enum +"/serviceconsumermanagement:v1/Enum/enumvalue": enumvalue +"/serviceconsumermanagement:v1/Enum/enumvalue/enumvalue": enumvalue +"/serviceconsumermanagement:v1/Enum/name": name +"/serviceconsumermanagement:v1/Enum/options": options +"/serviceconsumermanagement:v1/Enum/options/option": option +"/serviceconsumermanagement:v1/Enum/sourceContext": source_context +"/serviceconsumermanagement:v1/Enum/syntax": syntax +"/serviceconsumermanagement:v1/EnumValue": enum_value +"/serviceconsumermanagement:v1/EnumValue/name": name +"/serviceconsumermanagement:v1/EnumValue/number": number +"/serviceconsumermanagement:v1/EnumValue/options": options +"/serviceconsumermanagement:v1/EnumValue/options/option": option +"/serviceconsumermanagement:v1/Experimental": experimental +"/serviceconsumermanagement:v1/Experimental/authorization": authorization +"/serviceconsumermanagement:v1/Field": field +"/serviceconsumermanagement:v1/Field/cardinality": cardinality +"/serviceconsumermanagement:v1/Field/defaultValue": default_value +"/serviceconsumermanagement:v1/Field/jsonName": json_name +"/serviceconsumermanagement:v1/Field/kind": kind +"/serviceconsumermanagement:v1/Field/name": name +"/serviceconsumermanagement:v1/Field/number": number +"/serviceconsumermanagement:v1/Field/oneofIndex": oneof_index +"/serviceconsumermanagement:v1/Field/options": options +"/serviceconsumermanagement:v1/Field/options/option": option +"/serviceconsumermanagement:v1/Field/packed": packed +"/serviceconsumermanagement:v1/Field/typeUrl": type_url +"/serviceconsumermanagement:v1/Http": http +"/serviceconsumermanagement:v1/Http/fullyDecodeReservedExpansion": fully_decode_reserved_expansion +"/serviceconsumermanagement:v1/Http/rules": rules +"/serviceconsumermanagement:v1/Http/rules/rule": rule +"/serviceconsumermanagement:v1/HttpRule": http_rule +"/serviceconsumermanagement:v1/HttpRule/additionalBindings": additional_bindings +"/serviceconsumermanagement:v1/HttpRule/additionalBindings/additional_binding": additional_binding +"/serviceconsumermanagement:v1/HttpRule/authorizations": authorizations +"/serviceconsumermanagement:v1/HttpRule/authorizations/authorization": authorization +"/serviceconsumermanagement:v1/HttpRule/body": body +"/serviceconsumermanagement:v1/HttpRule/custom": custom +"/serviceconsumermanagement:v1/HttpRule/delete": delete +"/serviceconsumermanagement:v1/HttpRule/get": get +"/serviceconsumermanagement:v1/HttpRule/mediaDownload": media_download +"/serviceconsumermanagement:v1/HttpRule/mediaUpload": media_upload +"/serviceconsumermanagement:v1/HttpRule/patch": patch +"/serviceconsumermanagement:v1/HttpRule/post": post +"/serviceconsumermanagement:v1/HttpRule/put": put +"/serviceconsumermanagement:v1/HttpRule/responseBody": response_body +"/serviceconsumermanagement:v1/HttpRule/restCollection": rest_collection +"/serviceconsumermanagement:v1/HttpRule/restMethodName": rest_method_name +"/serviceconsumermanagement:v1/HttpRule/selector": selector +"/serviceconsumermanagement:v1/LabelDescriptor": label_descriptor +"/serviceconsumermanagement:v1/LabelDescriptor/description": description +"/serviceconsumermanagement:v1/LabelDescriptor/key": key +"/serviceconsumermanagement:v1/LabelDescriptor/valueType": value_type +"/serviceconsumermanagement:v1/ListOperationsResponse": list_operations_response +"/serviceconsumermanagement:v1/ListOperationsResponse/nextPageToken": next_page_token +"/serviceconsumermanagement:v1/ListOperationsResponse/operations": operations +"/serviceconsumermanagement:v1/ListOperationsResponse/operations/operation": operation +"/serviceconsumermanagement:v1/ListTenancyUnitsResponse": list_tenancy_units_response +"/serviceconsumermanagement:v1/ListTenancyUnitsResponse/nextPageToken": next_page_token +"/serviceconsumermanagement:v1/ListTenancyUnitsResponse/tenancyUnits": tenancy_units +"/serviceconsumermanagement:v1/ListTenancyUnitsResponse/tenancyUnits/tenancy_unit": tenancy_unit +"/serviceconsumermanagement:v1/LogDescriptor": log_descriptor +"/serviceconsumermanagement:v1/LogDescriptor/description": description +"/serviceconsumermanagement:v1/LogDescriptor/displayName": display_name +"/serviceconsumermanagement:v1/LogDescriptor/labels": labels +"/serviceconsumermanagement:v1/LogDescriptor/labels/label": label +"/serviceconsumermanagement:v1/LogDescriptor/name": name +"/serviceconsumermanagement:v1/Logging": logging +"/serviceconsumermanagement:v1/Logging/consumerDestinations": consumer_destinations +"/serviceconsumermanagement:v1/Logging/consumerDestinations/consumer_destination": consumer_destination +"/serviceconsumermanagement:v1/Logging/producerDestinations": producer_destinations +"/serviceconsumermanagement:v1/Logging/producerDestinations/producer_destination": producer_destination +"/serviceconsumermanagement:v1/LoggingDestination": logging_destination +"/serviceconsumermanagement:v1/LoggingDestination/logs": logs +"/serviceconsumermanagement:v1/LoggingDestination/logs/log": log +"/serviceconsumermanagement:v1/LoggingDestination/monitoredResource": monitored_resource +"/serviceconsumermanagement:v1/MediaDownload": media_download +"/serviceconsumermanagement:v1/MediaDownload/completeNotification": complete_notification +"/serviceconsumermanagement:v1/MediaDownload/downloadService": download_service +"/serviceconsumermanagement:v1/MediaDownload/dropzone": dropzone +"/serviceconsumermanagement:v1/MediaDownload/enabled": enabled +"/serviceconsumermanagement:v1/MediaDownload/maxDirectDownloadSize": max_direct_download_size +"/serviceconsumermanagement:v1/MediaDownload/useDirectDownload": use_direct_download +"/serviceconsumermanagement:v1/MediaUpload": media_upload +"/serviceconsumermanagement:v1/MediaUpload/completeNotification": complete_notification +"/serviceconsumermanagement:v1/MediaUpload/dropzone": dropzone +"/serviceconsumermanagement:v1/MediaUpload/enabled": enabled +"/serviceconsumermanagement:v1/MediaUpload/maxSize": max_size +"/serviceconsumermanagement:v1/MediaUpload/mimeTypes": mime_types +"/serviceconsumermanagement:v1/MediaUpload/mimeTypes/mime_type": mime_type +"/serviceconsumermanagement:v1/MediaUpload/progressNotification": progress_notification +"/serviceconsumermanagement:v1/MediaUpload/startNotification": start_notification +"/serviceconsumermanagement:v1/MediaUpload/uploadService": upload_service +"/serviceconsumermanagement:v1/Method": method_prop +"/serviceconsumermanagement:v1/Method/name": name +"/serviceconsumermanagement:v1/Method/options": options +"/serviceconsumermanagement:v1/Method/options/option": option +"/serviceconsumermanagement:v1/Method/requestStreaming": request_streaming +"/serviceconsumermanagement:v1/Method/requestTypeUrl": request_type_url +"/serviceconsumermanagement:v1/Method/responseStreaming": response_streaming +"/serviceconsumermanagement:v1/Method/responseTypeUrl": response_type_url +"/serviceconsumermanagement:v1/Method/syntax": syntax +"/serviceconsumermanagement:v1/MetricDescriptor": metric_descriptor +"/serviceconsumermanagement:v1/MetricDescriptor/description": description +"/serviceconsumermanagement:v1/MetricDescriptor/displayName": display_name +"/serviceconsumermanagement:v1/MetricDescriptor/labels": labels +"/serviceconsumermanagement:v1/MetricDescriptor/labels/label": label +"/serviceconsumermanagement:v1/MetricDescriptor/metricKind": metric_kind +"/serviceconsumermanagement:v1/MetricDescriptor/name": name +"/serviceconsumermanagement:v1/MetricDescriptor/type": type +"/serviceconsumermanagement:v1/MetricDescriptor/unit": unit +"/serviceconsumermanagement:v1/MetricDescriptor/valueType": value_type +"/serviceconsumermanagement:v1/MetricRule": metric_rule +"/serviceconsumermanagement:v1/MetricRule/metricCosts": metric_costs +"/serviceconsumermanagement:v1/MetricRule/metricCosts/metric_cost": metric_cost +"/serviceconsumermanagement:v1/MetricRule/selector": selector +"/serviceconsumermanagement:v1/Mixin": mixin +"/serviceconsumermanagement:v1/Mixin/name": name +"/serviceconsumermanagement:v1/Mixin/root": root +"/serviceconsumermanagement:v1/MonitoredResourceDescriptor": monitored_resource_descriptor +"/serviceconsumermanagement:v1/MonitoredResourceDescriptor/description": description +"/serviceconsumermanagement:v1/MonitoredResourceDescriptor/displayName": display_name +"/serviceconsumermanagement:v1/MonitoredResourceDescriptor/labels": labels +"/serviceconsumermanagement:v1/MonitoredResourceDescriptor/labels/label": label +"/serviceconsumermanagement:v1/MonitoredResourceDescriptor/name": name +"/serviceconsumermanagement:v1/MonitoredResourceDescriptor/type": type +"/serviceconsumermanagement:v1/Monitoring": monitoring +"/serviceconsumermanagement:v1/Monitoring/consumerDestinations": consumer_destinations +"/serviceconsumermanagement:v1/Monitoring/consumerDestinations/consumer_destination": consumer_destination +"/serviceconsumermanagement:v1/Monitoring/producerDestinations": producer_destinations +"/serviceconsumermanagement:v1/Monitoring/producerDestinations/producer_destination": producer_destination +"/serviceconsumermanagement:v1/MonitoringDestination": monitoring_destination +"/serviceconsumermanagement:v1/MonitoringDestination/metrics": metrics +"/serviceconsumermanagement:v1/MonitoringDestination/metrics/metric": metric +"/serviceconsumermanagement:v1/MonitoringDestination/monitoredResource": monitored_resource +"/serviceconsumermanagement:v1/OAuthRequirements": o_auth_requirements +"/serviceconsumermanagement:v1/OAuthRequirements/canonicalScopes": canonical_scopes +"/serviceconsumermanagement:v1/Operation": operation +"/serviceconsumermanagement:v1/Operation/done": done +"/serviceconsumermanagement:v1/Operation/error": error +"/serviceconsumermanagement:v1/Operation/metadata": metadata +"/serviceconsumermanagement:v1/Operation/metadata/metadatum": metadatum +"/serviceconsumermanagement:v1/Operation/name": name +"/serviceconsumermanagement:v1/Operation/response": response +"/serviceconsumermanagement:v1/Operation/response/response": response +"/serviceconsumermanagement:v1/Option": option +"/serviceconsumermanagement:v1/Option/name": name +"/serviceconsumermanagement:v1/Option/value": value +"/serviceconsumermanagement:v1/Option/value/value": value +"/serviceconsumermanagement:v1/Page": page +"/serviceconsumermanagement:v1/Page/content": content +"/serviceconsumermanagement:v1/Page/name": name +"/serviceconsumermanagement:v1/Page/subpages": subpages +"/serviceconsumermanagement:v1/Page/subpages/subpage": subpage +"/serviceconsumermanagement:v1/PolicyBinding": policy_binding +"/serviceconsumermanagement:v1/PolicyBinding/members": members +"/serviceconsumermanagement:v1/PolicyBinding/members/member": member +"/serviceconsumermanagement:v1/PolicyBinding/role": role +"/serviceconsumermanagement:v1/Quota": quota +"/serviceconsumermanagement:v1/Quota/limits": limits +"/serviceconsumermanagement:v1/Quota/limits/limit": limit +"/serviceconsumermanagement:v1/Quota/metricRules": metric_rules +"/serviceconsumermanagement:v1/Quota/metricRules/metric_rule": metric_rule +"/serviceconsumermanagement:v1/QuotaLimit": quota_limit +"/serviceconsumermanagement:v1/QuotaLimit/defaultLimit": default_limit +"/serviceconsumermanagement:v1/QuotaLimit/description": description +"/serviceconsumermanagement:v1/QuotaLimit/displayName": display_name +"/serviceconsumermanagement:v1/QuotaLimit/duration": duration +"/serviceconsumermanagement:v1/QuotaLimit/freeTier": free_tier +"/serviceconsumermanagement:v1/QuotaLimit/maxLimit": max_limit +"/serviceconsumermanagement:v1/QuotaLimit/metric": metric +"/serviceconsumermanagement:v1/QuotaLimit/name": name +"/serviceconsumermanagement:v1/QuotaLimit/unit": unit +"/serviceconsumermanagement:v1/QuotaLimit/values": values +"/serviceconsumermanagement:v1/QuotaLimit/values/value": value +"/serviceconsumermanagement:v1/RemoveTenantProjectRequest": remove_tenant_project_request +"/serviceconsumermanagement:v1/RemoveTenantProjectRequest/tag": tag +"/serviceconsumermanagement:v1/SearchTenancyUnitsResponse": search_tenancy_units_response +"/serviceconsumermanagement:v1/SearchTenancyUnitsResponse/nextPageToken": next_page_token +"/serviceconsumermanagement:v1/SearchTenancyUnitsResponse/tenancyUnits": tenancy_units +"/serviceconsumermanagement:v1/SearchTenancyUnitsResponse/tenancyUnits/tenancy_unit": tenancy_unit +"/serviceconsumermanagement:v1/Service": service +"/serviceconsumermanagement:v1/Service/apis": apis +"/serviceconsumermanagement:v1/Service/apis/api": api +"/serviceconsumermanagement:v1/Service/authentication": authentication +"/serviceconsumermanagement:v1/Service/backend": backend +"/serviceconsumermanagement:v1/Service/billing": billing +"/serviceconsumermanagement:v1/Service/configVersion": config_version +"/serviceconsumermanagement:v1/Service/context": context +"/serviceconsumermanagement:v1/Service/control": control +"/serviceconsumermanagement:v1/Service/customError": custom_error +"/serviceconsumermanagement:v1/Service/documentation": documentation +"/serviceconsumermanagement:v1/Service/endpoints": endpoints +"/serviceconsumermanagement:v1/Service/endpoints/endpoint": endpoint +"/serviceconsumermanagement:v1/Service/enums": enums +"/serviceconsumermanagement:v1/Service/enums/enum": enum +"/serviceconsumermanagement:v1/Service/experimental": experimental +"/serviceconsumermanagement:v1/Service/http": http +"/serviceconsumermanagement:v1/Service/id": id +"/serviceconsumermanagement:v1/Service/logging": logging +"/serviceconsumermanagement:v1/Service/logs": logs +"/serviceconsumermanagement:v1/Service/logs/log": log +"/serviceconsumermanagement:v1/Service/metrics": metrics +"/serviceconsumermanagement:v1/Service/metrics/metric": metric +"/serviceconsumermanagement:v1/Service/monitoredResources": monitored_resources +"/serviceconsumermanagement:v1/Service/monitoredResources/monitored_resource": monitored_resource +"/serviceconsumermanagement:v1/Service/monitoring": monitoring +"/serviceconsumermanagement:v1/Service/name": name +"/serviceconsumermanagement:v1/Service/producerProjectId": producer_project_id +"/serviceconsumermanagement:v1/Service/quota": quota +"/serviceconsumermanagement:v1/Service/sourceInfo": source_info +"/serviceconsumermanagement:v1/Service/systemParameters": system_parameters +"/serviceconsumermanagement:v1/Service/systemTypes": system_types +"/serviceconsumermanagement:v1/Service/systemTypes/system_type": system_type +"/serviceconsumermanagement:v1/Service/title": title +"/serviceconsumermanagement:v1/Service/types": types +"/serviceconsumermanagement:v1/Service/types/type": type +"/serviceconsumermanagement:v1/Service/usage": usage +"/serviceconsumermanagement:v1/Service/visibility": visibility +"/serviceconsumermanagement:v1/ServiceAccountConfig": service_account_config +"/serviceconsumermanagement:v1/ServiceAccountConfig/accountId": account_id +"/serviceconsumermanagement:v1/ServiceAccountConfig/tenantProjectRoles": tenant_project_roles +"/serviceconsumermanagement:v1/ServiceAccountConfig/tenantProjectRoles/tenant_project_role": tenant_project_role +"/serviceconsumermanagement:v1/SourceContext": source_context +"/serviceconsumermanagement:v1/SourceContext/fileName": file_name +"/serviceconsumermanagement:v1/SourceInfo": source_info +"/serviceconsumermanagement:v1/SourceInfo/sourceFiles": source_files +"/serviceconsumermanagement:v1/SourceInfo/sourceFiles/source_file": source_file +"/serviceconsumermanagement:v1/SourceInfo/sourceFiles/source_file/source_file": source_file +"/serviceconsumermanagement:v1/Status": status +"/serviceconsumermanagement:v1/Status/code": code +"/serviceconsumermanagement:v1/Status/details": details +"/serviceconsumermanagement:v1/Status/details/detail": detail +"/serviceconsumermanagement:v1/Status/details/detail/detail": detail +"/serviceconsumermanagement:v1/Status/message": message +"/serviceconsumermanagement:v1/SystemParameter": system_parameter +"/serviceconsumermanagement:v1/SystemParameter/httpHeader": http_header +"/serviceconsumermanagement:v1/SystemParameter/name": name +"/serviceconsumermanagement:v1/SystemParameter/urlQueryParameter": url_query_parameter +"/serviceconsumermanagement:v1/SystemParameterRule": system_parameter_rule +"/serviceconsumermanagement:v1/SystemParameterRule/parameters": parameters +"/serviceconsumermanagement:v1/SystemParameterRule/parameters/parameter": parameter +"/serviceconsumermanagement:v1/SystemParameterRule/selector": selector +"/serviceconsumermanagement:v1/SystemParameters": system_parameters +"/serviceconsumermanagement:v1/SystemParameters/rules": rules +"/serviceconsumermanagement:v1/SystemParameters/rules/rule": rule +"/serviceconsumermanagement:v1/TenancyUnit": tenancy_unit +"/serviceconsumermanagement:v1/TenancyUnit/consumer": consumer +"/serviceconsumermanagement:v1/TenancyUnit/createTime": create_time +"/serviceconsumermanagement:v1/TenancyUnit/name": name +"/serviceconsumermanagement:v1/TenancyUnit/service": service +"/serviceconsumermanagement:v1/TenancyUnit/tenantResources": tenant_resources +"/serviceconsumermanagement:v1/TenancyUnit/tenantResources/tenant_resource": tenant_resource +"/serviceconsumermanagement:v1/TenantProjectConfig": tenant_project_config +"/serviceconsumermanagement:v1/TenantProjectConfig/billingConfig": billing_config +"/serviceconsumermanagement:v1/TenantProjectConfig/folder": folder +"/serviceconsumermanagement:v1/TenantProjectConfig/labels": labels +"/serviceconsumermanagement:v1/TenantProjectConfig/labels/label": label +"/serviceconsumermanagement:v1/TenantProjectConfig/serviceAccountConfig": service_account_config +"/serviceconsumermanagement:v1/TenantProjectConfig/services": services +"/serviceconsumermanagement:v1/TenantProjectConfig/services/service": service +"/serviceconsumermanagement:v1/TenantProjectConfig/tenantProjectPolicy": tenant_project_policy +"/serviceconsumermanagement:v1/TenantProjectPolicy": tenant_project_policy +"/serviceconsumermanagement:v1/TenantProjectPolicy/policyBindings": policy_bindings +"/serviceconsumermanagement:v1/TenantProjectPolicy/policyBindings/policy_binding": policy_binding +"/serviceconsumermanagement:v1/TenantResource": tenant_resource +"/serviceconsumermanagement:v1/TenantResource/resource": resource +"/serviceconsumermanagement:v1/TenantResource/status": status +"/serviceconsumermanagement:v1/TenantResource/tag": tag +"/serviceconsumermanagement:v1/Type": type +"/serviceconsumermanagement:v1/Type/fields": fields +"/serviceconsumermanagement:v1/Type/fields/field": field +"/serviceconsumermanagement:v1/Type/name": name +"/serviceconsumermanagement:v1/Type/oneofs": oneofs +"/serviceconsumermanagement:v1/Type/oneofs/oneof": oneof +"/serviceconsumermanagement:v1/Type/options": options +"/serviceconsumermanagement:v1/Type/options/option": option +"/serviceconsumermanagement:v1/Type/sourceContext": source_context +"/serviceconsumermanagement:v1/Type/syntax": syntax +"/serviceconsumermanagement:v1/Usage": usage +"/serviceconsumermanagement:v1/Usage/producerNotificationChannel": producer_notification_channel +"/serviceconsumermanagement:v1/Usage/requirements": requirements +"/serviceconsumermanagement:v1/Usage/requirements/requirement": requirement +"/serviceconsumermanagement:v1/Usage/rules": rules +"/serviceconsumermanagement:v1/Usage/rules/rule": rule +"/serviceconsumermanagement:v1/UsageRule": usage_rule +"/serviceconsumermanagement:v1/UsageRule/allowUnregisteredCalls": allow_unregistered_calls +"/serviceconsumermanagement:v1/UsageRule/selector": selector +"/serviceconsumermanagement:v1/UsageRule/skipServiceControl": skip_service_control +"/serviceconsumermanagement:v1/Visibility": visibility +"/serviceconsumermanagement:v1/Visibility/rules": rules +"/serviceconsumermanagement:v1/Visibility/rules/rule": rule +"/serviceconsumermanagement:v1/VisibilityRule": visibility_rule +"/serviceconsumermanagement:v1/VisibilityRule/restriction": restriction +"/serviceconsumermanagement:v1/VisibilityRule/selector": selector +"/serviceconsumermanagement:v1/fields": fields +"/serviceconsumermanagement:v1/key": key +"/serviceconsumermanagement:v1/quotaUser": quota_user +"/serviceconsumermanagement:v1/serviceconsumermanagement.operations.cancel": cancel_operation +"/serviceconsumermanagement:v1/serviceconsumermanagement.operations.cancel/name": name +"/serviceconsumermanagement:v1/serviceconsumermanagement.operations.delete": delete_operation +"/serviceconsumermanagement:v1/serviceconsumermanagement.operations.delete/name": name +"/serviceconsumermanagement:v1/serviceconsumermanagement.operations.get": get_operation +"/serviceconsumermanagement:v1/serviceconsumermanagement.operations.get/name": name +"/serviceconsumermanagement:v1/serviceconsumermanagement.operations.list": list_operations +"/serviceconsumermanagement:v1/serviceconsumermanagement.operations.list/filter": filter +"/serviceconsumermanagement:v1/serviceconsumermanagement.operations.list/name": name +"/serviceconsumermanagement:v1/serviceconsumermanagement.operations.list/pageSize": page_size +"/serviceconsumermanagement:v1/serviceconsumermanagement.operations.list/pageToken": page_token +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.search": search_services +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.search/pageSize": page_size +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.search/pageToken": page_token +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.search/parent": parent +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.search/query": query +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.tenancyUnits.addProject": add_service_tenancy_unit_project +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.tenancyUnits.addProject/parent": parent +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.tenancyUnits.create": create_tenancy_unit +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.tenancyUnits.create/parent": parent +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.tenancyUnits.delete": delete_service_tenancy_unit +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.tenancyUnits.delete/name": name +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.tenancyUnits.list": list_service_tenancy_units +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.tenancyUnits.list/filter": filter +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.tenancyUnits.list/pageSize": page_size +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.tenancyUnits.list/pageToken": page_token +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.tenancyUnits.list/parent": parent +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.tenancyUnits.removeProject": remove_service_tenancy_unit_project +"/serviceconsumermanagement:v1/serviceconsumermanagement.services.tenancyUnits.removeProject/name": name "/servicecontrol:v1/AllocateInfo": allocate_info "/servicecontrol:v1/AllocateInfo/unusedArguments": unused_arguments "/servicecontrol:v1/AllocateInfo/unusedArguments/unused_argument": unused_argument @@ -54484,6 +59271,7 @@ "/slides:v1/ShapeBackgroundFill/propertyState": property_state "/slides:v1/ShapeBackgroundFill/solidFill": solid_fill "/slides:v1/ShapeProperties": shape_properties +"/slides:v1/ShapeProperties/contentAlignment": content_alignment "/slides:v1/ShapeProperties/link": link "/slides:v1/ShapeProperties/outline": outline "/slides:v1/ShapeProperties/shadow": shadow @@ -54547,6 +59335,7 @@ "/slides:v1/TableCellLocation/columnIndex": column_index "/slides:v1/TableCellLocation/rowIndex": row_index "/slides:v1/TableCellProperties": table_cell_properties +"/slides:v1/TableCellProperties/contentAlignment": content_alignment "/slides:v1/TableCellProperties/tableCellBackgroundFill": table_cell_background_fill "/slides:v1/TableColumnProperties": table_column_properties "/slides:v1/TableColumnProperties/columnWidth": column_width @@ -55428,6 +60217,7 @@ "/speech:v1/SpeechRecognitionResult": speech_recognition_result "/speech:v1/SpeechRecognitionResult/alternatives": alternatives "/speech:v1/SpeechRecognitionResult/alternatives/alternative": alternative +"/speech:v1/SpeechRecognitionResult/channelTag": channel_tag "/speech:v1/Status": status "/speech:v1/Status/code": code "/speech:v1/Status/details": details @@ -55900,6 +60690,20 @@ "/sqladmin:v1beta4/DatabasesListResponse/items": items "/sqladmin:v1beta4/DatabasesListResponse/items/item": item "/sqladmin:v1beta4/DatabasesListResponse/kind": kind +"/sqladmin:v1beta4/DemoteMasterConfiguration": demote_master_configuration +"/sqladmin:v1beta4/DemoteMasterConfiguration/kind": kind +"/sqladmin:v1beta4/DemoteMasterConfiguration/mysqlReplicaConfiguration": mysql_replica_configuration +"/sqladmin:v1beta4/DemoteMasterContext": demote_master_context +"/sqladmin:v1beta4/DemoteMasterContext/kind": kind +"/sqladmin:v1beta4/DemoteMasterContext/masterInstanceName": master_instance_name +"/sqladmin:v1beta4/DemoteMasterContext/replicaConfiguration": replica_configuration +"/sqladmin:v1beta4/DemoteMasterMySqlReplicaConfiguration": demote_master_my_sql_replica_configuration +"/sqladmin:v1beta4/DemoteMasterMySqlReplicaConfiguration/caCertificate": ca_certificate +"/sqladmin:v1beta4/DemoteMasterMySqlReplicaConfiguration/clientCertificate": client_certificate +"/sqladmin:v1beta4/DemoteMasterMySqlReplicaConfiguration/clientKey": client_key +"/sqladmin:v1beta4/DemoteMasterMySqlReplicaConfiguration/kind": kind +"/sqladmin:v1beta4/DemoteMasterMySqlReplicaConfiguration/password": password +"/sqladmin:v1beta4/DemoteMasterMySqlReplicaConfiguration/username": username "/sqladmin:v1beta4/ExportContext": export_context "/sqladmin:v1beta4/ExportContext/csvExportOptions": csv_export_options "/sqladmin:v1beta4/ExportContext/csvExportOptions/selectQuery": select_query @@ -55942,6 +60746,8 @@ "/sqladmin:v1beta4/ImportContext/uri": uri "/sqladmin:v1beta4/InstancesCloneRequest": clone_instances_request "/sqladmin:v1beta4/InstancesCloneRequest/cloneContext": clone_context +"/sqladmin:v1beta4/InstancesDemoteMasterRequest": instances_demote_master_request +"/sqladmin:v1beta4/InstancesDemoteMasterRequest/demoteMasterContext": demote_master_context "/sqladmin:v1beta4/InstancesExportRequest": export_instances_request "/sqladmin:v1beta4/InstancesExportRequest/exportContext": export_context "/sqladmin:v1beta4/InstancesFailoverRequest": instances_failover_request @@ -56153,6 +60959,9 @@ "/sqladmin:v1beta4/sql.instances.delete": delete_instance "/sqladmin:v1beta4/sql.instances.delete/instance": instance "/sqladmin:v1beta4/sql.instances.delete/project": project +"/sqladmin:v1beta4/sql.instances.demoteMaster": demote_instance_master +"/sqladmin:v1beta4/sql.instances.demoteMaster/instance": instance +"/sqladmin:v1beta4/sql.instances.demoteMaster/project": project "/sqladmin:v1beta4/sql.instances.export": export_instance "/sqladmin:v1beta4/sql.instances.export/instance": instance "/sqladmin:v1beta4/sql.instances.export/project": project @@ -57774,6 +62583,7 @@ "/tagmanager:v1/Tag/parameter": parameter "/tagmanager:v1/Tag/parameter/parameter": parameter "/tagmanager:v1/Tag/parentFolderId": parent_folder_id +"/tagmanager:v1/Tag/paused": paused "/tagmanager:v1/Tag/priority": priority "/tagmanager:v1/Tag/scheduleEndMs": schedule_end_ms "/tagmanager:v1/Tag/scheduleStartMs": schedule_start_ms @@ -57793,6 +62603,7 @@ "/tagmanager:v1/Trigger/autoEventFilter/auto_event_filter": auto_event_filter "/tagmanager:v1/Trigger/checkValidation": check_validation "/tagmanager:v1/Trigger/containerId": container_id +"/tagmanager:v1/Trigger/continuousTimeMinMilliseconds": continuous_time_min_milliseconds "/tagmanager:v1/Trigger/customEventFilter": custom_event_filter "/tagmanager:v1/Trigger/customEventFilter/custom_event_filter": custom_event_filter "/tagmanager:v1/Trigger/enableAllVideos": enable_all_videos @@ -57800,14 +62611,25 @@ "/tagmanager:v1/Trigger/filter": filter "/tagmanager:v1/Trigger/filter/filter": filter "/tagmanager:v1/Trigger/fingerprint": fingerprint +"/tagmanager:v1/Trigger/horizontalScrollPercentageList": horizontal_scroll_percentage_list "/tagmanager:v1/Trigger/interval": interval +"/tagmanager:v1/Trigger/intervalSeconds": interval_seconds "/tagmanager:v1/Trigger/limit": limit +"/tagmanager:v1/Trigger/maxTimerLengthSeconds": max_timer_length_seconds "/tagmanager:v1/Trigger/name": name +"/tagmanager:v1/Trigger/parameter": parameter +"/tagmanager:v1/Trigger/parameter/parameter": parameter "/tagmanager:v1/Trigger/parentFolderId": parent_folder_id +"/tagmanager:v1/Trigger/selector": selector +"/tagmanager:v1/Trigger/totalTimeMinMilliseconds": total_time_min_milliseconds "/tagmanager:v1/Trigger/triggerId": trigger_id "/tagmanager:v1/Trigger/type": type "/tagmanager:v1/Trigger/uniqueTriggerId": unique_trigger_id +"/tagmanager:v1/Trigger/verticalScrollPercentageList": vertical_scroll_percentage_list "/tagmanager:v1/Trigger/videoPercentageList": video_percentage_list +"/tagmanager:v1/Trigger/visibilitySelector": visibility_selector +"/tagmanager:v1/Trigger/visiblePercentageMax": visible_percentage_max +"/tagmanager:v1/Trigger/visiblePercentageMin": visible_percentage_min "/tagmanager:v1/Trigger/waitForTags": wait_for_tags "/tagmanager:v1/Trigger/waitForTagsTimeout": wait_for_tags_timeout "/tagmanager:v1/UserAccess": user_access @@ -58263,6 +63085,7 @@ "/tagmanager:v2/Tag/parameter/parameter": parameter "/tagmanager:v2/Tag/parentFolderId": parent_folder_id "/tagmanager:v2/Tag/path": path +"/tagmanager:v2/Tag/paused": paused "/tagmanager:v2/Tag/priority": priority "/tagmanager:v2/Tag/scheduleEndMs": schedule_end_ms "/tagmanager:v2/Tag/scheduleStartMs": schedule_start_ms @@ -59766,6 +64589,106 @@ "/toolresults:v1beta3firstparty/toolresults.projects.initializeSettings": initialize_project_settings "/toolresults:v1beta3firstparty/toolresults.projects.initializeSettings/projectId": project_id "/toolresults:v1beta3firstparty/userIp": user_ip +"/tpu:v1alpha1/Empty": empty +"/tpu:v1alpha1/ListLocationsResponse": list_locations_response +"/tpu:v1alpha1/ListLocationsResponse/locations": locations +"/tpu:v1alpha1/ListLocationsResponse/locations/location": location +"/tpu:v1alpha1/ListLocationsResponse/nextPageToken": next_page_token +"/tpu:v1alpha1/ListNodesResponse": list_nodes_response +"/tpu:v1alpha1/ListNodesResponse/nextPageToken": next_page_token +"/tpu:v1alpha1/ListNodesResponse/nodes": nodes +"/tpu:v1alpha1/ListNodesResponse/nodes/node": node +"/tpu:v1alpha1/ListOperationsResponse": list_operations_response +"/tpu:v1alpha1/ListOperationsResponse/nextPageToken": next_page_token +"/tpu:v1alpha1/ListOperationsResponse/operations": operations +"/tpu:v1alpha1/ListOperationsResponse/operations/operation": operation +"/tpu:v1alpha1/Location": location +"/tpu:v1alpha1/Location/labels": labels +"/tpu:v1alpha1/Location/labels/label": label +"/tpu:v1alpha1/Location/locationId": location_id +"/tpu:v1alpha1/Location/metadata": metadata +"/tpu:v1alpha1/Location/metadata/metadatum": metadatum +"/tpu:v1alpha1/Location/name": name +"/tpu:v1alpha1/NetworkEndpoint": network_endpoint +"/tpu:v1alpha1/NetworkEndpoint/ipAddress": ip_address +"/tpu:v1alpha1/NetworkEndpoint/port": port +"/tpu:v1alpha1/Node": node +"/tpu:v1alpha1/Node/acceleratorType": accelerator_type +"/tpu:v1alpha1/Node/cidrBlock": cidr_block +"/tpu:v1alpha1/Node/createTime": create_time +"/tpu:v1alpha1/Node/description": description +"/tpu:v1alpha1/Node/healthDescription": health_description +"/tpu:v1alpha1/Node/ipAddress": ip_address +"/tpu:v1alpha1/Node/name": name +"/tpu:v1alpha1/Node/network": network +"/tpu:v1alpha1/Node/networkEndpoints": network_endpoints +"/tpu:v1alpha1/Node/networkEndpoints/network_endpoint": network_endpoint +"/tpu:v1alpha1/Node/port": port +"/tpu:v1alpha1/Node/serviceAccount": service_account +"/tpu:v1alpha1/Node/state": state +"/tpu:v1alpha1/Node/tensorflowVersion": tensorflow_version +"/tpu:v1alpha1/Operation": operation +"/tpu:v1alpha1/Operation/done": done +"/tpu:v1alpha1/Operation/error": error +"/tpu:v1alpha1/Operation/metadata": metadata +"/tpu:v1alpha1/Operation/metadata/metadatum": metadatum +"/tpu:v1alpha1/Operation/name": name +"/tpu:v1alpha1/Operation/response": response +"/tpu:v1alpha1/Operation/response/response": response +"/tpu:v1alpha1/OperationMetadata": operation_metadata +"/tpu:v1alpha1/OperationMetadata/apiVersion": api_version +"/tpu:v1alpha1/OperationMetadata/cancelRequested": cancel_requested +"/tpu:v1alpha1/OperationMetadata/createTime": create_time +"/tpu:v1alpha1/OperationMetadata/endTime": end_time +"/tpu:v1alpha1/OperationMetadata/statusDetail": status_detail +"/tpu:v1alpha1/OperationMetadata/target": target +"/tpu:v1alpha1/OperationMetadata/verb": verb +"/tpu:v1alpha1/ReimageNodeRequest": reimage_node_request +"/tpu:v1alpha1/ReimageNodeRequest/tensorflowVersion": tensorflow_version +"/tpu:v1alpha1/ResetNodeRequest": reset_node_request +"/tpu:v1alpha1/Status": status +"/tpu:v1alpha1/Status/code": code +"/tpu:v1alpha1/Status/details": details +"/tpu:v1alpha1/Status/details/detail": detail +"/tpu:v1alpha1/Status/details/detail/detail": detail +"/tpu:v1alpha1/Status/message": message +"/tpu:v1alpha1/fields": fields +"/tpu:v1alpha1/key": key +"/tpu:v1alpha1/quotaUser": quota_user +"/tpu:v1alpha1/tpu.projects.locations.get": get_project_location +"/tpu:v1alpha1/tpu.projects.locations.get/name": name +"/tpu:v1alpha1/tpu.projects.locations.list": list_project_locations +"/tpu:v1alpha1/tpu.projects.locations.list/filter": filter +"/tpu:v1alpha1/tpu.projects.locations.list/name": name +"/tpu:v1alpha1/tpu.projects.locations.list/pageSize": page_size +"/tpu:v1alpha1/tpu.projects.locations.list/pageToken": page_token +"/tpu:v1alpha1/tpu.projects.locations.nodes.create": create_project_location_node +"/tpu:v1alpha1/tpu.projects.locations.nodes.create/nodeId": node_id +"/tpu:v1alpha1/tpu.projects.locations.nodes.create/parent": parent +"/tpu:v1alpha1/tpu.projects.locations.nodes.delete": delete_project_location_node +"/tpu:v1alpha1/tpu.projects.locations.nodes.delete/name": name +"/tpu:v1alpha1/tpu.projects.locations.nodes.get": get_project_location_node +"/tpu:v1alpha1/tpu.projects.locations.nodes.get/name": name +"/tpu:v1alpha1/tpu.projects.locations.nodes.list": list_project_location_nodes +"/tpu:v1alpha1/tpu.projects.locations.nodes.list/pageSize": page_size +"/tpu:v1alpha1/tpu.projects.locations.nodes.list/pageToken": page_token +"/tpu:v1alpha1/tpu.projects.locations.nodes.list/parent": parent +"/tpu:v1alpha1/tpu.projects.locations.nodes.reimage": reimage_project_location_node +"/tpu:v1alpha1/tpu.projects.locations.nodes.reimage/name": name +"/tpu:v1alpha1/tpu.projects.locations.nodes.reimage/tensorflowVersion": tensorflow_version +"/tpu:v1alpha1/tpu.projects.locations.nodes.reset": reset_project_location_node +"/tpu:v1alpha1/tpu.projects.locations.nodes.reset/name": name +"/tpu:v1alpha1/tpu.projects.locations.operations.cancel": cancel_project_location_operation +"/tpu:v1alpha1/tpu.projects.locations.operations.cancel/name": name +"/tpu:v1alpha1/tpu.projects.locations.operations.delete": delete_project_location_operation +"/tpu:v1alpha1/tpu.projects.locations.operations.delete/name": name +"/tpu:v1alpha1/tpu.projects.locations.operations.get": get_project_location_operation +"/tpu:v1alpha1/tpu.projects.locations.operations.get/name": name +"/tpu:v1alpha1/tpu.projects.locations.operations.list": list_project_location_operations +"/tpu:v1alpha1/tpu.projects.locations.operations.list/filter": filter +"/tpu:v1alpha1/tpu.projects.locations.operations.list/name": name +"/tpu:v1alpha1/tpu.projects.locations.operations.list/pageSize": page_size +"/tpu:v1alpha1/tpu.projects.locations.operations.list/pageToken": page_token "/translate:v2/DetectLanguageRequest": detect_language_request "/translate:v2/DetectLanguageRequest/q": q "/translate:v2/DetectLanguageRequest/q/q": q @@ -59966,6 +64889,7 @@ "/vault:v1/vault.matters.list": list_matters "/vault:v1/vault.matters.list/pageSize": page_size "/vault:v1/vault.matters.list/pageToken": page_token +"/vault:v1/vault.matters.list/state": state "/vault:v1/vault.matters.list/view": view "/vault:v1/vault.matters.removePermissions": remove_matter_permissions "/vault:v1/vault.matters.removePermissions/matterId": matter_id @@ -59981,15 +64905,38 @@ "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_AnnotateVideoResponse": google_cloud_videointelligence_v1_annotate_video_response "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_AnnotateVideoResponse/annotationResults": annotation_results "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_AnnotateVideoResponse/annotationResults/annotation_result": annotation_result +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_Entity": google_cloud_videointelligence_v1_entity +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_Entity/description": description +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_Entity/entityId": entity_id +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_Entity/languageCode": language_code +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_ExplicitContentAnnotation": google_cloud_videointelligence_v1_explicit_content_annotation +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_ExplicitContentAnnotation/frames": frames +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_ExplicitContentAnnotation/frames/frame": frame +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_ExplicitContentFrame": google_cloud_videointelligence_v1_explicit_content_frame +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_ExplicitContentFrame/pornographyLikelihood": pornography_likelihood +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_ExplicitContentFrame/timeOffset": time_offset "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelAnnotation": google_cloud_videointelligence_v1_label_annotation +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelAnnotation/categoryEntities": category_entities +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelAnnotation/categoryEntities/category_entity": category_entity "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelAnnotation/description": description +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelAnnotation/entity": entity +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelAnnotation/frames": frames +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelAnnotation/frames/frame": frame "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelAnnotation/languageCode": language_code "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelAnnotation/locations": locations "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelAnnotation/locations/location": location +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelAnnotation/segments": segments +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelAnnotation/segments/segment": segment +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelFrame": google_cloud_videointelligence_v1_label_frame +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelFrame/confidence": confidence +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelFrame/timeOffset": time_offset "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelLocation": google_cloud_videointelligence_v1_label_location "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelLocation/confidence": confidence "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelLocation/level": level "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelLocation/segment": segment +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelSegment": google_cloud_videointelligence_v1_label_segment +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelSegment/confidence": confidence +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_LabelSegment/segment": segment "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_SafeSearchAnnotation": google_cloud_videointelligence_v1_safe_search_annotation "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_SafeSearchAnnotation/adult": adult "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_SafeSearchAnnotation/time": time @@ -60000,16 +64947,26 @@ "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationProgress/updateTime": update_time "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults": google_cloud_videointelligence_v1_video_annotation_results "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/error": error +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/explicitAnnotation": explicit_annotation +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/frameLabelAnnotations": frame_label_annotations +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/frameLabelAnnotations/frame_label_annotation": frame_label_annotation "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/inputUri": input_uri "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/labelAnnotations": label_annotations "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/labelAnnotations/label_annotation": label_annotation "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/safeSearchAnnotations": safe_search_annotations "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/safeSearchAnnotations/safe_search_annotation": safe_search_annotation +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/segmentLabelAnnotations": segment_label_annotations +? "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/segmentLabelAnnotations/segment_label_annotation" +: segment_label_annotation "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/shotAnnotations": shot_annotations "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/shotAnnotations/shot_annotation": shot_annotation +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/shotLabelAnnotations": shot_label_annotations +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/shotLabelAnnotations/shot_label_annotation": shot_label_annotation "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoSegment": google_cloud_videointelligence_v1_video_segment "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoSegment/endTime": end_time +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoSegment/endTimeOffset": end_time_offset "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoSegment/startTime": start_time +"/videointelligence:v1beta1/GoogleCloudVideointelligenceV1_VideoSegment/startTimeOffset": start_time_offset "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress": google_cloud_videointelligence_v1beta1_annotate_video_progress "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress/annotationProgress": annotation_progress "/videointelligence:v1beta1/GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress/annotationProgress/annotation_progress": annotation_progress @@ -60233,6 +65190,198 @@ "/vision:v1/Feature": feature "/vision:v1/Feature/maxResults": max_results "/vision:v1/Feature/type": type +"/vision:v1/GoogleCloudVisionV1AnnotateImageRequest": google_cloud_vision_v1_annotate_image_request +"/vision:v1/GoogleCloudVisionV1AnnotateImageRequest/features": features +"/vision:v1/GoogleCloudVisionV1AnnotateImageRequest/features/feature": feature +"/vision:v1/GoogleCloudVisionV1AnnotateImageRequest/image": image +"/vision:v1/GoogleCloudVisionV1AnnotateImageRequest/imageContext": image_context +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse": google_cloud_vision_v1_annotate_image_response +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/cropHintsAnnotation": crop_hints_annotation +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/error": error +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/faceAnnotations": face_annotations +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/faceAnnotations/face_annotation": face_annotation +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/fullTextAnnotation": full_text_annotation +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/imagePropertiesAnnotation": image_properties_annotation +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/labelAnnotations": label_annotations +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/labelAnnotations/label_annotation": label_annotation +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/landmarkAnnotations": landmark_annotations +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/landmarkAnnotations/landmark_annotation": landmark_annotation +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/logoAnnotations": logo_annotations +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/logoAnnotations/logo_annotation": logo_annotation +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/safeSearchAnnotation": safe_search_annotation +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/textAnnotations": text_annotations +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/textAnnotations/text_annotation": text_annotation +"/vision:v1/GoogleCloudVisionV1AnnotateImageResponse/webDetection": web_detection +"/vision:v1/GoogleCloudVisionV1BatchAnnotateImagesRequest": google_cloud_vision_v1_batch_annotate_images_request +"/vision:v1/GoogleCloudVisionV1BatchAnnotateImagesRequest/requests": requests +"/vision:v1/GoogleCloudVisionV1BatchAnnotateImagesRequest/requests/request": request +"/vision:v1/GoogleCloudVisionV1BatchAnnotateImagesResponse": google_cloud_vision_v1_batch_annotate_images_response +"/vision:v1/GoogleCloudVisionV1BatchAnnotateImagesResponse/responses": responses +"/vision:v1/GoogleCloudVisionV1BatchAnnotateImagesResponse/responses/response": response +"/vision:v1/GoogleCloudVisionV1Block": google_cloud_vision_v1_block +"/vision:v1/GoogleCloudVisionV1Block/blockType": block_type +"/vision:v1/GoogleCloudVisionV1Block/boundingBox": bounding_box +"/vision:v1/GoogleCloudVisionV1Block/paragraphs": paragraphs +"/vision:v1/GoogleCloudVisionV1Block/paragraphs/paragraph": paragraph +"/vision:v1/GoogleCloudVisionV1Block/property": property +"/vision:v1/GoogleCloudVisionV1BoundingPoly": google_cloud_vision_v1_bounding_poly +"/vision:v1/GoogleCloudVisionV1BoundingPoly/vertices": vertices +"/vision:v1/GoogleCloudVisionV1BoundingPoly/vertices/vertex": vertex +"/vision:v1/GoogleCloudVisionV1ColorInfo": google_cloud_vision_v1_color_info +"/vision:v1/GoogleCloudVisionV1ColorInfo/color": color +"/vision:v1/GoogleCloudVisionV1ColorInfo/pixelFraction": pixel_fraction +"/vision:v1/GoogleCloudVisionV1ColorInfo/score": score +"/vision:v1/GoogleCloudVisionV1CropHint": google_cloud_vision_v1_crop_hint +"/vision:v1/GoogleCloudVisionV1CropHint/boundingPoly": bounding_poly +"/vision:v1/GoogleCloudVisionV1CropHint/confidence": confidence +"/vision:v1/GoogleCloudVisionV1CropHint/importanceFraction": importance_fraction +"/vision:v1/GoogleCloudVisionV1CropHintsAnnotation": google_cloud_vision_v1_crop_hints_annotation +"/vision:v1/GoogleCloudVisionV1CropHintsAnnotation/cropHints": crop_hints +"/vision:v1/GoogleCloudVisionV1CropHintsAnnotation/cropHints/crop_hint": crop_hint +"/vision:v1/GoogleCloudVisionV1CropHintsParams": google_cloud_vision_v1_crop_hints_params +"/vision:v1/GoogleCloudVisionV1CropHintsParams/aspectRatios": aspect_ratios +"/vision:v1/GoogleCloudVisionV1CropHintsParams/aspectRatios/aspect_ratio": aspect_ratio +"/vision:v1/GoogleCloudVisionV1DominantColorsAnnotation": google_cloud_vision_v1_dominant_colors_annotation +"/vision:v1/GoogleCloudVisionV1DominantColorsAnnotation/colors": colors +"/vision:v1/GoogleCloudVisionV1DominantColorsAnnotation/colors/color": color +"/vision:v1/GoogleCloudVisionV1EntityAnnotation": google_cloud_vision_v1_entity_annotation +"/vision:v1/GoogleCloudVisionV1EntityAnnotation/boundingPoly": bounding_poly +"/vision:v1/GoogleCloudVisionV1EntityAnnotation/confidence": confidence +"/vision:v1/GoogleCloudVisionV1EntityAnnotation/description": description +"/vision:v1/GoogleCloudVisionV1EntityAnnotation/locale": locale +"/vision:v1/GoogleCloudVisionV1EntityAnnotation/locations": locations +"/vision:v1/GoogleCloudVisionV1EntityAnnotation/locations/location": location +"/vision:v1/GoogleCloudVisionV1EntityAnnotation/mid": mid +"/vision:v1/GoogleCloudVisionV1EntityAnnotation/properties": properties +"/vision:v1/GoogleCloudVisionV1EntityAnnotation/properties/property": property +"/vision:v1/GoogleCloudVisionV1EntityAnnotation/score": score +"/vision:v1/GoogleCloudVisionV1EntityAnnotation/topicality": topicality +"/vision:v1/GoogleCloudVisionV1FaceAnnotation": google_cloud_vision_v1_face_annotation +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/angerLikelihood": anger_likelihood +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/blurredLikelihood": blurred_likelihood +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/boundingPoly": bounding_poly +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/detectionConfidence": detection_confidence +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/fdBoundingPoly": fd_bounding_poly +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/headwearLikelihood": headwear_likelihood +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/joyLikelihood": joy_likelihood +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/landmarkingConfidence": landmarking_confidence +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/landmarks": landmarks +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/landmarks/landmark": landmark +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/panAngle": pan_angle +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/rollAngle": roll_angle +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/sorrowLikelihood": sorrow_likelihood +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/surpriseLikelihood": surprise_likelihood +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/tiltAngle": tilt_angle +"/vision:v1/GoogleCloudVisionV1FaceAnnotation/underExposedLikelihood": under_exposed_likelihood +"/vision:v1/GoogleCloudVisionV1FaceAnnotationLandmark": google_cloud_vision_v1_face_annotation_landmark +"/vision:v1/GoogleCloudVisionV1FaceAnnotationLandmark/position": position +"/vision:v1/GoogleCloudVisionV1FaceAnnotationLandmark/type": type +"/vision:v1/GoogleCloudVisionV1Feature": google_cloud_vision_v1_feature +"/vision:v1/GoogleCloudVisionV1Feature/maxResults": max_results +"/vision:v1/GoogleCloudVisionV1Feature/type": type +"/vision:v1/GoogleCloudVisionV1Image": google_cloud_vision_v1_image +"/vision:v1/GoogleCloudVisionV1Image/content": content +"/vision:v1/GoogleCloudVisionV1Image/source": source +"/vision:v1/GoogleCloudVisionV1ImageContext": google_cloud_vision_v1_image_context +"/vision:v1/GoogleCloudVisionV1ImageContext/cropHintsParams": crop_hints_params +"/vision:v1/GoogleCloudVisionV1ImageContext/languageHints": language_hints +"/vision:v1/GoogleCloudVisionV1ImageContext/languageHints/language_hint": language_hint +"/vision:v1/GoogleCloudVisionV1ImageContext/latLongRect": lat_long_rect +"/vision:v1/GoogleCloudVisionV1ImageProperties": google_cloud_vision_v1_image_properties +"/vision:v1/GoogleCloudVisionV1ImageProperties/dominantColors": dominant_colors +"/vision:v1/GoogleCloudVisionV1ImageSource": google_cloud_vision_v1_image_source +"/vision:v1/GoogleCloudVisionV1ImageSource/gcsImageUri": gcs_image_uri +"/vision:v1/GoogleCloudVisionV1ImageSource/imageUri": image_uri +"/vision:v1/GoogleCloudVisionV1LatLongRect": google_cloud_vision_v1_lat_long_rect +"/vision:v1/GoogleCloudVisionV1LatLongRect/maxLatLng": max_lat_lng +"/vision:v1/GoogleCloudVisionV1LatLongRect/minLatLng": min_lat_lng +"/vision:v1/GoogleCloudVisionV1LocationInfo": google_cloud_vision_v1_location_info +"/vision:v1/GoogleCloudVisionV1LocationInfo/latLng": lat_lng +"/vision:v1/GoogleCloudVisionV1Page": google_cloud_vision_v1_page +"/vision:v1/GoogleCloudVisionV1Page/blocks": blocks +"/vision:v1/GoogleCloudVisionV1Page/blocks/block": block +"/vision:v1/GoogleCloudVisionV1Page/height": height +"/vision:v1/GoogleCloudVisionV1Page/property": property +"/vision:v1/GoogleCloudVisionV1Page/width": width +"/vision:v1/GoogleCloudVisionV1Paragraph": google_cloud_vision_v1_paragraph +"/vision:v1/GoogleCloudVisionV1Paragraph/boundingBox": bounding_box +"/vision:v1/GoogleCloudVisionV1Paragraph/property": property +"/vision:v1/GoogleCloudVisionV1Paragraph/words": words +"/vision:v1/GoogleCloudVisionV1Paragraph/words/word": word +"/vision:v1/GoogleCloudVisionV1Position": google_cloud_vision_v1_position +"/vision:v1/GoogleCloudVisionV1Position/x": x +"/vision:v1/GoogleCloudVisionV1Position/y": y +"/vision:v1/GoogleCloudVisionV1Position/z": z +"/vision:v1/GoogleCloudVisionV1Property": google_cloud_vision_v1_property +"/vision:v1/GoogleCloudVisionV1Property/name": name +"/vision:v1/GoogleCloudVisionV1Property/uint64Value": uint64_value +"/vision:v1/GoogleCloudVisionV1Property/value": value +"/vision:v1/GoogleCloudVisionV1SafeSearchAnnotation": google_cloud_vision_v1_safe_search_annotation +"/vision:v1/GoogleCloudVisionV1SafeSearchAnnotation/adult": adult +"/vision:v1/GoogleCloudVisionV1SafeSearchAnnotation/medical": medical +"/vision:v1/GoogleCloudVisionV1SafeSearchAnnotation/spoof": spoof +"/vision:v1/GoogleCloudVisionV1SafeSearchAnnotation/violence": violence +"/vision:v1/GoogleCloudVisionV1Symbol": google_cloud_vision_v1_symbol +"/vision:v1/GoogleCloudVisionV1Symbol/boundingBox": bounding_box +"/vision:v1/GoogleCloudVisionV1Symbol/property": property +"/vision:v1/GoogleCloudVisionV1Symbol/text": text +"/vision:v1/GoogleCloudVisionV1TextAnnotation": google_cloud_vision_v1_text_annotation +"/vision:v1/GoogleCloudVisionV1TextAnnotation/pages": pages +"/vision:v1/GoogleCloudVisionV1TextAnnotation/pages/page": page +"/vision:v1/GoogleCloudVisionV1TextAnnotation/text": text +"/vision:v1/GoogleCloudVisionV1TextAnnotationDetectedBreak": google_cloud_vision_v1_text_annotation_detected_break +"/vision:v1/GoogleCloudVisionV1TextAnnotationDetectedBreak/isPrefix": is_prefix +"/vision:v1/GoogleCloudVisionV1TextAnnotationDetectedBreak/type": type +"/vision:v1/GoogleCloudVisionV1TextAnnotationDetectedLanguage": google_cloud_vision_v1_text_annotation_detected_language +"/vision:v1/GoogleCloudVisionV1TextAnnotationDetectedLanguage/confidence": confidence +"/vision:v1/GoogleCloudVisionV1TextAnnotationDetectedLanguage/languageCode": language_code +"/vision:v1/GoogleCloudVisionV1TextAnnotationTextProperty": google_cloud_vision_v1_text_annotation_text_property +"/vision:v1/GoogleCloudVisionV1TextAnnotationTextProperty/detectedBreak": detected_break +"/vision:v1/GoogleCloudVisionV1TextAnnotationTextProperty/detectedLanguages": detected_languages +"/vision:v1/GoogleCloudVisionV1TextAnnotationTextProperty/detectedLanguages/detected_language": detected_language +"/vision:v1/GoogleCloudVisionV1Vertex": google_cloud_vision_v1_vertex +"/vision:v1/GoogleCloudVisionV1Vertex/x": x +"/vision:v1/GoogleCloudVisionV1Vertex/y": y +"/vision:v1/GoogleCloudVisionV1WebDetection": google_cloud_vision_v1_web_detection +"/vision:v1/GoogleCloudVisionV1WebDetection/fullMatchingImages": full_matching_images +"/vision:v1/GoogleCloudVisionV1WebDetection/fullMatchingImages/full_matching_image": full_matching_image +"/vision:v1/GoogleCloudVisionV1WebDetection/pagesWithMatchingImages": pages_with_matching_images +"/vision:v1/GoogleCloudVisionV1WebDetection/pagesWithMatchingImages/pages_with_matching_image": pages_with_matching_image +"/vision:v1/GoogleCloudVisionV1WebDetection/partialMatchingImages": partial_matching_images +"/vision:v1/GoogleCloudVisionV1WebDetection/partialMatchingImages/partial_matching_image": partial_matching_image +"/vision:v1/GoogleCloudVisionV1WebDetection/visuallySimilarImages": visually_similar_images +"/vision:v1/GoogleCloudVisionV1WebDetection/visuallySimilarImages/visually_similar_image": visually_similar_image +"/vision:v1/GoogleCloudVisionV1WebDetection/webEntities": web_entities +"/vision:v1/GoogleCloudVisionV1WebDetection/webEntities/web_entity": web_entity +"/vision:v1/GoogleCloudVisionV1WebDetectionWebEntity": google_cloud_vision_v1_web_detection_web_entity +"/vision:v1/GoogleCloudVisionV1WebDetectionWebEntity/description": description +"/vision:v1/GoogleCloudVisionV1WebDetectionWebEntity/entityId": entity_id +"/vision:v1/GoogleCloudVisionV1WebDetectionWebEntity/score": score +"/vision:v1/GoogleCloudVisionV1WebDetectionWebImage": google_cloud_vision_v1_web_detection_web_image +"/vision:v1/GoogleCloudVisionV1WebDetectionWebImage/score": score +"/vision:v1/GoogleCloudVisionV1WebDetectionWebImage/url": url +"/vision:v1/GoogleCloudVisionV1WebDetectionWebPage": google_cloud_vision_v1_web_detection_web_page +"/vision:v1/GoogleCloudVisionV1WebDetectionWebPage/score": score +"/vision:v1/GoogleCloudVisionV1WebDetectionWebPage/url": url +"/vision:v1/GoogleCloudVisionV1Word": google_cloud_vision_v1_word +"/vision:v1/GoogleCloudVisionV1Word/boundingBox": bounding_box +"/vision:v1/GoogleCloudVisionV1Word/property": property +"/vision:v1/GoogleCloudVisionV1Word/symbols": symbols +"/vision:v1/GoogleCloudVisionV1Word/symbols/symbol": symbol +"/vision:v1/GoogleRpcStatus": google_rpc_status +"/vision:v1/GoogleRpcStatus/code": code +"/vision:v1/GoogleRpcStatus/details": details +"/vision:v1/GoogleRpcStatus/details/detail": detail +"/vision:v1/GoogleRpcStatus/details/detail/detail": detail +"/vision:v1/GoogleRpcStatus/message": message +"/vision:v1/GoogleTypeColor": google_type_color +"/vision:v1/GoogleTypeColor/alpha": alpha +"/vision:v1/GoogleTypeColor/blue": blue +"/vision:v1/GoogleTypeColor/green": green +"/vision:v1/GoogleTypeColor/red": red +"/vision:v1/GoogleTypeLatLng": google_type_lat_lng +"/vision:v1/GoogleTypeLatLng/latitude": latitude +"/vision:v1/GoogleTypeLatLng/longitude": longitude "/vision:v1/Image": image "/vision:v1/Image/content": content "/vision:v1/Image/source": source @@ -60332,6 +65481,236 @@ "/vision:v1/key": key "/vision:v1/quotaUser": quota_user "/vision:v1/vision.images.annotate": annotate_image +"/vision:v1p1beta1/Color": color +"/vision:v1p1beta1/Color/alpha": alpha +"/vision:v1p1beta1/Color/blue": blue +"/vision:v1p1beta1/Color/green": green +"/vision:v1p1beta1/Color/red": red +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageRequest": google_cloud_vision_v1p1beta1_annotate_image_request +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageRequest/features": features +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageRequest/features/feature": feature +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageRequest/image": image +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageRequest/imageContext": image_context +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse": google_cloud_vision_v1p1beta1_annotate_image_response +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/cropHintsAnnotation": crop_hints_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/error": error +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/faceAnnotations": face_annotations +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/faceAnnotations/face_annotation": face_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/fullTextAnnotation": full_text_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/imagePropertiesAnnotation": image_properties_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/labelAnnotations": label_annotations +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/labelAnnotations/label_annotation": label_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/landmarkAnnotations": landmark_annotations +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/landmarkAnnotations/landmark_annotation": landmark_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/logoAnnotations": logo_annotations +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/logoAnnotations/logo_annotation": logo_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/safeSearchAnnotation": safe_search_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/textAnnotations": text_annotations +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/textAnnotations/text_annotation": text_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/webDetection": web_detection +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest": google_cloud_vision_v1p1beta1_batch_annotate_images_request +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest/requests": requests +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest/requests/request": request +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse": google_cloud_vision_v1p1beta1_batch_annotate_images_response +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse/responses": responses +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse/responses/response": response +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Block": google_cloud_vision_v1p1beta1_block +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Block/blockType": block_type +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Block/boundingBox": bounding_box +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Block/confidence": confidence +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Block/paragraphs": paragraphs +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Block/paragraphs/paragraph": paragraph +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Block/property": property +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1BoundingPoly": google_cloud_vision_v1p1beta1_bounding_poly +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1BoundingPoly/vertices": vertices +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1BoundingPoly/vertices/vertex": vertex +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ColorInfo": google_cloud_vision_v1p1beta1_color_info +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ColorInfo/color": color +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ColorInfo/pixelFraction": pixel_fraction +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ColorInfo/score": score +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1CropHint": google_cloud_vision_v1p1beta1_crop_hint +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1CropHint/boundingPoly": bounding_poly +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1CropHint/confidence": confidence +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1CropHint/importanceFraction": importance_fraction +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1CropHintsAnnotation": google_cloud_vision_v1p1beta1_crop_hints_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1CropHintsAnnotation/cropHints": crop_hints +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1CropHintsAnnotation/cropHints/crop_hint": crop_hint +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1CropHintsParams": google_cloud_vision_v1p1beta1_crop_hints_params +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1CropHintsParams/aspectRatios": aspect_ratios +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1CropHintsParams/aspectRatios/aspect_ratio": aspect_ratio +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1DominantColorsAnnotation": google_cloud_vision_v1p1beta1_dominant_colors_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1DominantColorsAnnotation/colors": colors +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1DominantColorsAnnotation/colors/color": color +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1EntityAnnotation": google_cloud_vision_v1p1beta1_entity_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1EntityAnnotation/boundingPoly": bounding_poly +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1EntityAnnotation/confidence": confidence +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1EntityAnnotation/description": description +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1EntityAnnotation/locale": locale +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1EntityAnnotation/locations": locations +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1EntityAnnotation/locations/location": location +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1EntityAnnotation/mid": mid +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1EntityAnnotation/properties": properties +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1EntityAnnotation/properties/property": property +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1EntityAnnotation/score": score +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1EntityAnnotation/topicality": topicality +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation": google_cloud_vision_v1p1beta1_face_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/angerLikelihood": anger_likelihood +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/blurredLikelihood": blurred_likelihood +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/boundingPoly": bounding_poly +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/detectionConfidence": detection_confidence +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/fdBoundingPoly": fd_bounding_poly +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/headwearLikelihood": headwear_likelihood +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/joyLikelihood": joy_likelihood +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/landmarkingConfidence": landmarking_confidence +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/landmarks": landmarks +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/landmarks/landmark": landmark +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/panAngle": pan_angle +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/rollAngle": roll_angle +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/sorrowLikelihood": sorrow_likelihood +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/surpriseLikelihood": surprise_likelihood +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/tiltAngle": tilt_angle +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotation/underExposedLikelihood": under_exposed_likelihood +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": google_cloud_vision_v1p1beta1_face_annotation_landmark +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotationLandmark/position": position +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1FaceAnnotationLandmark/type": type +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Feature": google_cloud_vision_v1p1beta1_feature +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Feature/maxResults": max_results +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Feature/model": model +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Feature/type": type +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Image": google_cloud_vision_v1p1beta1_image +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Image/content": content +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Image/source": source +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageContext": google_cloud_vision_v1p1beta1_image_context +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageContext/cropHintsParams": crop_hints_params +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageContext/languageHints": language_hints +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageContext/languageHints/language_hint": language_hint +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageContext/latLongRect": lat_long_rect +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageContext/webDetectionParams": web_detection_params +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageProperties": google_cloud_vision_v1p1beta1_image_properties +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageProperties/dominantColors": dominant_colors +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageSource": google_cloud_vision_v1p1beta1_image_source +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageSource/gcsImageUri": gcs_image_uri +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageSource/imageUri": image_uri +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1LatLongRect": google_cloud_vision_v1p1beta1_lat_long_rect +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1LatLongRect/maxLatLng": max_lat_lng +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1LatLongRect/minLatLng": min_lat_lng +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1LocationInfo": google_cloud_vision_v1p1beta1_location_info +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1LocationInfo/latLng": lat_lng +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Page": google_cloud_vision_v1p1beta1_page +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Page/blocks": blocks +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Page/blocks/block": block +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Page/confidence": confidence +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Page/height": height +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Page/property": property +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Page/width": width +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Paragraph": google_cloud_vision_v1p1beta1_paragraph +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Paragraph/boundingBox": bounding_box +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Paragraph/confidence": confidence +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Paragraph/property": property +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Paragraph/words": words +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Paragraph/words/word": word +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Position": google_cloud_vision_v1p1beta1_position +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Position/x": x +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Position/y": y +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Position/z": z +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Property": google_cloud_vision_v1p1beta1_property +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Property/name": name +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Property/uint64Value": uint64_value +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Property/value": value +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1SafeSearchAnnotation": google_cloud_vision_v1p1beta1_safe_search_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1SafeSearchAnnotation/adult": adult +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1SafeSearchAnnotation/medical": medical +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1SafeSearchAnnotation/racy": racy +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1SafeSearchAnnotation/spoof": spoof +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1SafeSearchAnnotation/violence": violence +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Symbol": google_cloud_vision_v1p1beta1_symbol +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Symbol/boundingBox": bounding_box +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Symbol/confidence": confidence +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Symbol/property": property +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Symbol/text": text +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1TextAnnotation": google_cloud_vision_v1p1beta1_text_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1TextAnnotation/pages": pages +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1TextAnnotation/pages/page": page +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1TextAnnotation/text": text +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak": google_cloud_vision_v1p1beta1_text_annotation_detected_break +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak/isPrefix": is_prefix +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak/type": type +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage": google_cloud_vision_v1p1beta1_text_annotation_detected_language +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage/confidence": confidence +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage/languageCode": language_code +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1TextAnnotationTextProperty": google_cloud_vision_v1p1beta1_text_annotation_text_property +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1TextAnnotationTextProperty/detectedBreak": detected_break +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1TextAnnotationTextProperty/detectedLanguages": detected_languages +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1TextAnnotationTextProperty/detectedLanguages/detected_language": detected_language +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Vertex": google_cloud_vision_v1p1beta1_vertex +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Vertex/x": x +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Vertex/y": y +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetection": google_cloud_vision_v1p1beta1_web_detection +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetection/bestGuessLabels": best_guess_labels +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetection/bestGuessLabels/best_guess_label": best_guess_label +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetection/fullMatchingImages": full_matching_images +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetection/fullMatchingImages/full_matching_image": full_matching_image +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetection/pagesWithMatchingImages": pages_with_matching_images +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetection/pagesWithMatchingImages/pages_with_matching_image": pages_with_matching_image +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetection/partialMatchingImages": partial_matching_images +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetection/partialMatchingImages/partial_matching_image": partial_matching_image +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetection/visuallySimilarImages": visually_similar_images +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetection/visuallySimilarImages/visually_similar_image": visually_similar_image +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetection/webEntities": web_entities +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetection/webEntities/web_entity": web_entity +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionParams": google_cloud_vision_v1p1beta1_web_detection_params +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionParams/includeGeoResults": include_geo_results +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebEntity": google_cloud_vision_v1p1beta1_web_detection_web_entity +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebEntity/description": description +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebEntity/entityId": entity_id +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebEntity/score": score +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebImage": google_cloud_vision_v1p1beta1_web_detection_web_image +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebImage/score": score +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebImage/url": url +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebLabel": google_cloud_vision_v1p1beta1_web_detection_web_label +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebLabel/label": label +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebLabel/languageCode": language_code +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebPage": google_cloud_vision_v1p1beta1_web_detection_web_page +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebPage/fullMatchingImages": full_matching_images +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebPage/fullMatchingImages/full_matching_image": full_matching_image +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebPage/pageTitle": page_title +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebPage/partialMatchingImages": partial_matching_images +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebPage/partialMatchingImages/partial_matching_image": partial_matching_image +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebPage/score": score +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1WebDetectionWebPage/url": url +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Word": google_cloud_vision_v1p1beta1_word +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Word/boundingBox": bounding_box +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Word/confidence": confidence +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Word/property": property +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Word/symbols": symbols +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Word/symbols/symbol": symbol +"/vision:v1p1beta1/GoogleRpcStatus": google_rpc_status +"/vision:v1p1beta1/GoogleRpcStatus/code": code +"/vision:v1p1beta1/GoogleRpcStatus/details": details +"/vision:v1p1beta1/GoogleRpcStatus/details/detail": detail +"/vision:v1p1beta1/GoogleRpcStatus/details/detail/detail": detail +"/vision:v1p1beta1/GoogleRpcStatus/message": message +"/vision:v1p1beta1/GoogleTypeColor": google_type_color +"/vision:v1p1beta1/GoogleTypeColor/alpha": alpha +"/vision:v1p1beta1/GoogleTypeColor/blue": blue +"/vision:v1p1beta1/GoogleTypeColor/green": green +"/vision:v1p1beta1/GoogleTypeColor/red": red +"/vision:v1p1beta1/GoogleTypeLatLng": google_type_lat_lng +"/vision:v1p1beta1/GoogleTypeLatLng/latitude": latitude +"/vision:v1p1beta1/GoogleTypeLatLng/longitude": longitude +"/vision:v1p1beta1/LatLng": lat_lng +"/vision:v1p1beta1/LatLng/latitude": latitude +"/vision:v1p1beta1/LatLng/longitude": longitude +"/vision:v1p1beta1/Status": status +"/vision:v1p1beta1/Status/code": code +"/vision:v1p1beta1/Status/details": details +"/vision:v1p1beta1/Status/details/detail": detail +"/vision:v1p1beta1/Status/details/detail/detail": detail +"/vision:v1p1beta1/Status/message": message +"/vision:v1p1beta1/fields": fields +"/vision:v1p1beta1/key": key +"/vision:v1p1beta1/quotaUser": quota_user +"/vision:v1p1beta1/vision.images.annotate": annotate_image "/webfonts:v1/Webfont": webfont "/webfonts:v1/Webfont/category": category "/webfonts:v1/Webfont/family": family @@ -62552,6 +67931,8 @@ "/youtubePartner:v1/Package/locale": locale "/youtubePartner:v1/Package/name": name "/youtubePartner:v1/Package/status": status +"/youtubePartner:v1/Package/statusReports": status_reports +"/youtubePartner:v1/Package/statusReports/status_report": status_report "/youtubePartner:v1/Package/timeCreated": time_created "/youtubePartner:v1/Package/type": type "/youtubePartner:v1/Package/uploaderName": uploader_name @@ -62676,9 +68057,23 @@ "/youtubePartner:v1/ShowDetails/episodeTitle": episode_title "/youtubePartner:v1/ShowDetails/seasonNumber": season_number "/youtubePartner:v1/ShowDetails/title": title +"/youtubePartner:v1/SpreadsheetTemplate": spreadsheet_template +"/youtubePartner:v1/SpreadsheetTemplate/kind": kind +"/youtubePartner:v1/SpreadsheetTemplate/status": status +"/youtubePartner:v1/SpreadsheetTemplate/templateContent": template_content +"/youtubePartner:v1/SpreadsheetTemplate/templateName": template_name +"/youtubePartner:v1/SpreadsheetTemplate/templateType": template_type +"/youtubePartner:v1/SpreadsheetTemplateListResponse": spreadsheet_template_list_response +"/youtubePartner:v1/SpreadsheetTemplateListResponse/items": items +"/youtubePartner:v1/SpreadsheetTemplateListResponse/items/item": item +"/youtubePartner:v1/SpreadsheetTemplateListResponse/kind": kind +"/youtubePartner:v1/SpreadsheetTemplateListResponse/status": status "/youtubePartner:v1/StateCompleted": state_completed "/youtubePartner:v1/StateCompleted/state": state "/youtubePartner:v1/StateCompleted/timeCompleted": time_completed +"/youtubePartner:v1/StatusReport": status_report +"/youtubePartner:v1/StatusReport/statusContent": status_content +"/youtubePartner:v1/StatusReport/statusFileName": status_file_name "/youtubePartner:v1/TerritoryCondition": territory_condition "/youtubePartner:v1/TerritoryCondition/territories": territories "/youtubePartner:v1/TerritoryCondition/territories/territory": territory @@ -63005,6 +68400,9 @@ "/youtubePartner:v1/youtubePartner.references.update/onBehalfOfContentOwner": on_behalf_of_content_owner "/youtubePartner:v1/youtubePartner.references.update/referenceId": reference_id "/youtubePartner:v1/youtubePartner.references.update/releaseClaims": release_claims +"/youtubePartner:v1/youtubePartner.spreadsheetTemplate.list": list_spreadsheet_templates +"/youtubePartner:v1/youtubePartner.spreadsheetTemplate.list/locale": locale +"/youtubePartner:v1/youtubePartner.spreadsheetTemplate.list/onBehalfOfContentOwner": on_behalf_of_content_owner "/youtubePartner:v1/youtubePartner.uploader.list": list_uploaders "/youtubePartner:v1/youtubePartner.uploader.list/onBehalfOfContentOwner": on_behalf_of_content_owner "/youtubePartner:v1/youtubePartner.validator.validate": validate_validator diff --git a/generated/google/apis/adexchangebuyer2_v2beta1.rb b/generated/google/apis/adexchangebuyer2_v2beta1.rb index c3ed19a28..41bdedcc2 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/ad-exchange/buyer-rest/reference/rest/ module Adexchangebuyer2V2beta1 VERSION = 'V2beta1' - REVISION = '20171005' + REVISION = '20171108' # Manage your Ad Exchange buyer account configuration AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer' diff --git a/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb b/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb index 72f51ef72..9e9a11f58 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb @@ -311,6 +311,18 @@ module Google # @return [String] attr_accessor :entity_type + # Optional arbitrary unique identifier of this client buyer from the + # standpoint of its Ad Exchange sponsor buyer. + # This field can be used to associate a client buyer with the identifier + # in the namespace of its sponsor buyer, lookup client buyers by that + # identifier and verify whether an Ad Exchange counterpart of a given client + # buyer already exists. + # If present, must be unique among all the client buyers for its + # Ad Exchange sponsor buyer. + # Corresponds to the JSON property `partnerClientId` + # @return [String] + attr_accessor :partner_client_id + # The role which is assigned to the client buyer. Each role implies a set of # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`, # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`. @@ -340,6 +352,7 @@ module Google @entity_id = args[:entity_id] if args.key?(:entity_id) @entity_name = args[:entity_name] if args.key?(:entity_name) @entity_type = args[:entity_type] if args.key?(:entity_type) + @partner_client_id = args[:partner_client_id] if args.key?(:partner_client_id) @role = args[:role] if args.key?(:role) @status = args[:status] if args.key?(:status) @visible_to_seller = args[:visible_to_seller] if args.key?(:visible_to_seller) @@ -837,17 +850,16 @@ module Google # @return [Google::Apis::Adexchangebuyer2V2beta1::AbsoluteDateRange] attr_accessor :absolute_date_range - # The ID of the buyer account on which to filter; optional. - # Corresponds to the JSON property `buyerAccountId` - # @return [Fixnum] - attr_accessor :buyer_account_id - - # The ID of the creative on which to filter; optional. + # The ID of the creative on which to filter; optional. This field may be set + # only for a filter set that accesses buyer-level troubleshooting data, i.e. + # one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. # Corresponds to the JSON property `creativeId` # @return [String] attr_accessor :creative_id - # The ID of the deal on which to filter; optional. + # The ID of the deal on which to filter; optional. This field may be set + # only for a filter set that accesses buyer-level troubleshooting data, i.e. + # one whose name matches the `bidders/*/accounts/*/filterSets/*` pattern. # Corresponds to the JSON property `dealId` # @return [Fixnum] attr_accessor :deal_id @@ -857,13 +869,6 @@ module Google # @return [String] attr_accessor :environment - # The ID of the filter set; unique within the account of the filter set - # owner. - # The value of this field is ignored in create operations. - # Corresponds to the JSON property `filterSetId` - # @return [Fixnum] - attr_accessor :filter_set_id - # The format on which to filter; optional. # Corresponds to the JSON property `format` # @return [String] @@ -875,16 +880,11 @@ module Google # data) # - `bidders/*/accounts/*/filterSets/*` (for accessing buyer-level # troubleshooting data) + # This field is required in create operations. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The account ID of the buyer who owns this filter set. - # The value of this field is ignored in create operations. - # Corresponds to the JSON property `ownerAccountId` - # @return [Fixnum] - attr_accessor :owner_account_id - # The list of platforms on which to filter; may be empty. The filters # represented by multiple platforms are ORed together (i.e. if non-empty, # results must match any one of the platforms). @@ -933,14 +933,11 @@ module Google # Update properties of this object def update!(**args) @absolute_date_range = args[:absolute_date_range] if args.key?(:absolute_date_range) - @buyer_account_id = args[:buyer_account_id] if args.key?(:buyer_account_id) @creative_id = args[:creative_id] if args.key?(:creative_id) @deal_id = args[:deal_id] if args.key?(:deal_id) @environment = args[:environment] if args.key?(:environment) - @filter_set_id = args[:filter_set_id] if args.key?(:filter_set_id) @format = args[:format] if args.key?(:format) @name = args[:name] if args.key?(:name) - @owner_account_id = args[:owner_account_id] if args.key?(:owner_account_id) @platforms = args[:platforms] if args.key?(:platforms) @realtime_time_range = args[:realtime_time_range] if args.key?(:realtime_time_range) @relative_date_range = args[:relative_date_range] if args.key?(:relative_date_range) @@ -1183,8 +1180,7 @@ module Google # A token to retrieve the next page of results. # Pass this value in the # ListBidMetricsRequest.pageToken - # field in the subsequent call to the - # accounts.filterSets.bidMetrics.list + # field in the subsequent call to the bidMetrics.list # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -1214,8 +1210,7 @@ module Google # A token to retrieve the next page of results. # Pass this value in the # ListBidResponseErrorsRequest.pageToken - # field in the subsequent call to the - # accounts.filterSets.bidResponseErrors.list + # field in the subsequent call to the bidResponseErrors.list # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -1246,8 +1241,7 @@ module Google # A token to retrieve the next page of results. # Pass this value in the # ListBidResponsesWithoutBidsRequest.pageToken - # field in the subsequent call to the - # accounts.filterSets.bidResponsesWithoutBids.list + # field in the subsequent call to the bidResponsesWithoutBids.list # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -1370,8 +1364,7 @@ module Google # A token to retrieve the next page of results. # Pass this value in the # ListCreativeStatusBreakdownByCreativeRequest.pageToken - # field in the subsequent call to the - # accounts.filterSets.filteredBids.creatives.list + # field in the subsequent call to the filteredBids.creatives.list # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -1407,8 +1400,7 @@ module Google # A token to retrieve the next page of results. # Pass this value in the # ListCreativeStatusBreakdownByDetailRequest.pageToken - # field in the subsequent call to the - # accounts.filterSets.filteredBids.details.list + # field in the subsequent call to the filteredBids.details.list # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -1528,8 +1520,7 @@ module Google # A token to retrieve the next page of results. # Pass this value in the # ListFilteredBidRequestsRequest.pageToken - # field in the subsequent call to the - # accounts.filterSets.filteredBidRequests.list + # field in the subsequent call to the filteredBidRequests.list # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -1560,8 +1551,7 @@ module Google # A token to retrieve the next page of results. # Pass this value in the # ListFilteredBidsRequest.pageToken - # field in the subsequent call to the - # accounts.filterSets.filteredBids.list + # field in the subsequent call to the filteredBids.list # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -1591,8 +1581,7 @@ module Google # A token to retrieve the next page of results. # Pass this value in the # ListImpressionMetricsRequest.pageToken - # field in the subsequent call to the - # accounts.filterSets.impressionMetrics.list + # field in the subsequent call to the impressionMetrics.list # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -1622,8 +1611,7 @@ module Google # A token to retrieve the next page of results. # Pass this value in the # ListLosingBidsRequest.pageToken - # field in the subsequent call to the - # accounts.filterSets.losingBids.list + # field in the subsequent call to the losingBids.list # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] @@ -1648,8 +1636,7 @@ module Google # A token to retrieve the next page of results. # Pass this value in the # ListNonBillableWinningBidsRequest.pageToken - # field in the subsequent call to the - # accounts.filterSets.nonBillableWinningBids.list + # field in the subsequent call to the nonBillableWinningBids.list # method to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] diff --git a/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb b/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb index 7aaad6594..2e18f9bd4 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb @@ -446,6 +446,7 @@ module Google property :entity_id, :numeric_string => true, as: 'entityId' property :entity_name, as: 'entityName' property :entity_type, as: 'entityType' + property :partner_client_id, as: 'partnerClientId' property :role, as: 'role' property :status, as: 'status' property :visible_to_seller, as: 'visibleToSeller' @@ -566,14 +567,11 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :absolute_date_range, as: 'absoluteDateRange', class: Google::Apis::Adexchangebuyer2V2beta1::AbsoluteDateRange, decorator: Google::Apis::Adexchangebuyer2V2beta1::AbsoluteDateRange::Representation - property :buyer_account_id, :numeric_string => true, as: 'buyerAccountId' property :creative_id, as: 'creativeId' property :deal_id, :numeric_string => true, as: 'dealId' property :environment, as: 'environment' - property :filter_set_id, :numeric_string => true, as: 'filterSetId' property :format, as: 'format' property :name, as: 'name' - property :owner_account_id, :numeric_string => true, as: 'ownerAccountId' collection :platforms, as: 'platforms' property :realtime_time_range, as: 'realtimeTimeRange', class: Google::Apis::Adexchangebuyer2V2beta1::RealtimeTimeRange, decorator: Google::Apis::Adexchangebuyer2V2beta1::RealtimeTimeRange::Representation diff --git a/generated/google/apis/adexchangebuyer2_v2beta1/service.rb b/generated/google/apis/adexchangebuyer2_v2beta1/service.rb index 277aaf558..01cca5091 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1/service.rb @@ -127,6 +127,10 @@ module Google # ListClientsResponse.nextPageToken # returned from the previous call to the # accounts.clients.list method. + # @param [String] partner_client_id + # Optional unique identifier (from the standpoint of an Ad Exchange sponsor + # buyer partner) of the client to return. + # If specified, at most one client will be returned in the response. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -144,13 +148,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_clients(account_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_account_clients(account_id, page_size: nil, page_token: nil, partner_client_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/clients', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListClientsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListClientsResponse command.params['accountId'] = account_id unless account_id.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['partnerClientId'] = partner_client_id unless partner_client_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -835,8 +840,14 @@ module Google end # Creates the specified filter set for the account with the given account ID. - # @param [Fixnum] account_id - # Account ID of the buyer. + # @param [String] owner_name + # Name of the owner (bidder or account) of the filter set to be created. + # For example: + # - For a bidder-level filter set for bidder 123: `bidders/123` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456` # @param [Google::Apis::Adexchangebuyer2V2beta1::FilterSet] filter_set_object # @param [Boolean] is_transient # Whether the filter set is transient, or should be persisted indefinitely. @@ -859,13 +870,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_filter_set(account_id, filter_set_object = nil, is_transient: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v2beta1/accounts/{accountId}/filterSets', options) + def create_bidder_account_filter_set(owner_name, filter_set_object = nil, is_transient: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+ownerName}/filterSets', options) command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation command.request_object = filter_set_object command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet - command.params['accountId'] = account_id unless account_id.nil? + command.params['ownerName'] = owner_name unless owner_name.nil? command.query['isTransient'] = is_transient unless is_transient.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? @@ -874,10 +885,15 @@ module Google # Deletes the requested filter set from the account with the given account # ID. - # @param [Fixnum] account_id - # Account ID of the buyer. - # @param [Fixnum] filter_set_id - # The ID of the filter set to delete. + # @param [String] name + # Full name of the resource to delete. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -895,12 +911,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_filter_set(account_id, filter_set_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}', options) + def delete_bidder_account_filter_set(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v2beta1/{+name}', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty - command.params['accountId'] = account_id unless account_id.nil? - command.params['filterSetId'] = filter_set_id unless filter_set_id.nil? + command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) @@ -908,10 +923,15 @@ module Google # Retrieves the requested filter set for the account with the given account # ID. - # @param [Fixnum] account_id - # Account ID of the buyer. - # @param [Fixnum] filter_set_id - # The ID of the filter set to get. + # @param [String] name + # Full name of the resource being requested. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -929,20 +949,25 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_filter_set(account_id, filter_set_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}', options) + def get_bidder_account_filter_set(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+name}', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet - command.params['accountId'] = account_id unless account_id.nil? - command.params['filterSetId'] = filter_set_id unless filter_set_id.nil? + command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Lists all filter sets for the account with the given account ID. - # @param [Fixnum] account_id - # Account ID of the buyer. + # @param [String] owner_name + # Name of the owner (bidder or account) of the filter sets to be listed. + # For example: + # - For a bidder-level filter set for bidder 123: `bidders/123` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. @@ -970,11 +995,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_filter_sets(account_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets', options) + def list_bidder_account_filter_sets(owner_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+ownerName}/filterSets', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse - command.params['accountId'] = account_id unless account_id.nil? + command.params['ownerName'] = owner_name unless owner_name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? @@ -983,10 +1008,15 @@ module Google end # Lists all metrics that are measured in terms of number of bids. - # @param [Fixnum] account_id - # Account ID of the buyer. - # @param [Fixnum] filter_set_id - # The ID of the filter set to apply. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. @@ -994,8 +1024,7 @@ module Google # A token identifying a page of results the server should return. # Typically, this is the value of # ListBidMetricsResponse.nextPageToken - # returned from the previous call to the - # accounts.filterSets.bidMetrics.list + # returned from the previous call to the bidMetrics.list # method. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1014,12 +1043,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_filter_set_bid_metrics(account_id, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidMetrics', options) + def list_bidder_account_filter_set_bid_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidMetrics', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['filterSetId'] = filter_set_id unless filter_set_id.nil? + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? @@ -1029,10 +1057,15 @@ module Google # List all errors that occurred in bid responses, with the number of bid # responses affected for each reason. - # @param [Fixnum] account_id - # Account ID of the buyer. - # @param [Fixnum] filter_set_id - # The ID of the filter set to apply. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. @@ -1040,8 +1073,7 @@ module Google # A token identifying a page of results the server should return. # Typically, this is the value of # ListBidResponseErrorsResponse.nextPageToken - # returned from the previous call to the - # accounts.filterSets.bidResponseErrors.list + # returned from the previous call to the bidResponseErrors.list # method. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1060,12 +1092,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_filter_set_bid_response_errors(account_id, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponseErrors', options) + def list_bidder_account_filter_set_bid_response_errors(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidResponseErrors', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['filterSetId'] = filter_set_id unless filter_set_id.nil? + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? @@ -1075,10 +1106,15 @@ module Google # List all reasons for which bid responses were considered to have no # applicable bids, with the number of bid responses affected for each reason. - # @param [Fixnum] account_id - # Account ID of the buyer. - # @param [Fixnum] filter_set_id - # The ID of the filter set to apply. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. @@ -1086,8 +1122,7 @@ module Google # A token identifying a page of results the server should return. # Typically, this is the value of # ListBidResponsesWithoutBidsResponse.nextPageToken - # returned from the previous call to the - # accounts.filterSets.bidResponsesWithoutBids.list + # returned from the previous call to the bidResponsesWithoutBids.list # method. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1106,12 +1141,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_filter_set_bid_responses_without_bids(account_id, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/bidResponsesWithoutBids', options) + def list_bidder_account_filter_set_bid_responses_without_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidResponsesWithoutBids', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['filterSetId'] = filter_set_id unless filter_set_id.nil? + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? @@ -1121,10 +1155,15 @@ module Google # List all reasons that caused a bid request not to be sent for an # impression, with the number of bid requests not sent for each reason. - # @param [Fixnum] account_id - # Account ID of the buyer. - # @param [Fixnum] filter_set_id - # The ID of the filter set to apply. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. @@ -1132,8 +1171,7 @@ module Google # A token identifying a page of results the server should return. # Typically, this is the value of # ListFilteredBidRequestsResponse.nextPageToken - # returned from the previous call to the - # accounts.filterSets.filteredBidRequests.list + # returned from the previous call to the filteredBidRequests.list # method. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1152,12 +1190,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_filter_set_filtered_bid_requests(account_id, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBidRequests', options) + def list_bidder_account_filter_set_filtered_bid_requests(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBidRequests', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['filterSetId'] = filter_set_id unless filter_set_id.nil? + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? @@ -1167,10 +1204,15 @@ module Google # List all reasons for which bids were filtered, with the number of bids # filtered for each reason. - # @param [Fixnum] account_id - # Account ID of the buyer. - # @param [Fixnum] filter_set_id - # The ID of the filter set to apply. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. @@ -1178,8 +1220,7 @@ module Google # A token identifying a page of results the server should return. # Typically, this is the value of # ListFilteredBidsResponse.nextPageToken - # returned from the previous call to the - # accounts.filterSets.filteredBids.list + # returned from the previous call to the filteredBids.list # method. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1198,12 +1239,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_filter_set_filtered_bids(account_id, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids', options) + def list_bidder_account_filter_set_filtered_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['filterSetId'] = filter_set_id unless filter_set_id.nil? + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? @@ -1213,10 +1253,15 @@ module Google # List all creatives associated with a specific reason for which bids were # filtered, with the number of bids filtered for each creative. - # @param [Fixnum] account_id - # Account ID of the buyer. - # @param [Fixnum] filter_set_id - # The ID of the filter set to apply. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] creative_status_id # The ID of the creative status for which to retrieve a breakdown by # creative. @@ -1230,8 +1275,7 @@ module Google # A token identifying a page of results the server should return. # Typically, this is the value of # ListCreativeStatusBreakdownByCreativeResponse.nextPageToken - # returned from the previous call to the - # accounts.filterSets.filteredBids.creatives.list + # returned from the previous call to the filteredBids.creatives.list # method. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1250,12 +1294,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_filter_set_filtered_bid_creatives(account_id, filter_set_id, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives', options) + def list_bidder_account_filter_set_filtered_bid_creatives(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['filterSetId'] = filter_set_id unless filter_set_id.nil? + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? command.params['creativeStatusId'] = creative_status_id unless creative_status_id.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -1266,10 +1309,15 @@ module Google # List all details associated with a specific reason for which bids were # filtered, with the number of bids filtered for each detail. - # @param [Fixnum] account_id - # Account ID of the buyer. - # @param [Fixnum] filter_set_id - # The ID of the filter set to apply. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] creative_status_id # The ID of the creative status for which to retrieve a breakdown by detail. # See @@ -1283,8 +1331,7 @@ module Google # A token identifying a page of results the server should return. # Typically, this is the value of # ListCreativeStatusBreakdownByDetailResponse.nextPageToken - # returned from the previous call to the - # accounts.filterSets.filteredBids.details.list + # returned from the previous call to the filteredBids.details.list # method. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1303,12 +1350,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_filter_set_filtered_bid_details(account_id, filter_set_id, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details', options) + def list_bidder_account_filter_set_filtered_bid_details(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['filterSetId'] = filter_set_id unless filter_set_id.nil? + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? command.params['creativeStatusId'] = creative_status_id unless creative_status_id.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? @@ -1318,10 +1364,15 @@ module Google end # Lists all metrics that are measured in terms of number of impressions. - # @param [Fixnum] account_id - # Account ID of the buyer. - # @param [Fixnum] filter_set_id - # The ID of the filter set to apply. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. @@ -1329,8 +1380,7 @@ module Google # A token identifying a page of results the server should return. # Typically, this is the value of # ListImpressionMetricsResponse.nextPageToken - # returned from the previous call to the - # accounts.filterSets.impressionMetrics.list + # returned from the previous call to the impressionMetrics.list # method. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1349,12 +1399,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_filter_set_impression_metrics(account_id, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/impressionMetrics', options) + def list_bidder_account_filter_set_impression_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/impressionMetrics', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['filterSetId'] = filter_set_id unless filter_set_id.nil? + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? @@ -1364,10 +1413,15 @@ module Google # List all reasons for which bids lost in the auction, with the number of # bids that lost for each reason. - # @param [Fixnum] account_id - # Account ID of the buyer. - # @param [Fixnum] filter_set_id - # The ID of the filter set to apply. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. @@ -1375,8 +1429,7 @@ module Google # A token identifying a page of results the server should return. # Typically, this is the value of # ListLosingBidsResponse.nextPageToken - # returned from the previous call to the - # accounts.filterSets.losingBids.list + # returned from the previous call to the losingBids.list # method. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1395,12 +1448,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_filter_set_losing_bids(account_id, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/losingBids', options) + def list_bidder_account_filter_set_losing_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/losingBids', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['filterSetId'] = filter_set_id unless filter_set_id.nil? + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? @@ -1410,10 +1462,15 @@ module Google # List all reasons for which winning bids were not billable, with the number # of bids not billed for each reason. - # @param [Fixnum] account_id - # Account ID of the buyer. - # @param [Fixnum] filter_set_id - # The ID of the filter set to apply. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` # @param [Fixnum] page_size # Requested page size. The server may return fewer results than requested. # If unspecified, the server will pick an appropriate default. @@ -1421,8 +1478,7 @@ module Google # A token identifying a page of results the server should return. # Typically, this is the value of # ListNonBillableWinningBidsResponse.nextPageToken - # returned from the previous call to the - # accounts.filterSets.nonBillableWinningBids.list + # returned from the previous call to the nonBillableWinningBids.list # method. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1441,12 +1497,681 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_filter_set_non_billable_winning_bids(account_id, filter_set_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v2beta1/accounts/{accountId}/filterSets/{filterSetId}/nonBillableWinningBids', options) + def list_bidder_account_filter_set_non_billable_winning_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/nonBillableWinningBids', options) command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse::Representation command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['filterSetId'] = filter_set_id unless filter_set_id.nil? + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates the specified filter set for the account with the given account ID. + # @param [String] owner_name + # Name of the owner (bidder or account) of the filter set to be created. + # For example: + # - For a bidder-level filter set for bidder 123: `bidders/123` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456` + # @param [Google::Apis::Adexchangebuyer2V2beta1::FilterSet] filter_set_object + # @param [Boolean] is_transient + # Whether the filter set is transient, or should be persisted indefinitely. + # By default, filter sets are not transient. + # If transient, it will be available for at least 1 hour after creation. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::FilterSet] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::Adexchangebuyer2V2beta1::FilterSet] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_bidder_filter_set(owner_name, filter_set_object = nil, is_transient: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+ownerName}/filterSets', options) + command.request_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation + command.request_object = filter_set_object + command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation + command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet + command.params['ownerName'] = owner_name unless owner_name.nil? + command.query['isTransient'] = is_transient unless is_transient.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the requested filter set from the account with the given account + # ID. + # @param [String] name + # Full name of the resource to delete. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::Adexchangebuyer2V2beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_bidder_filter_set(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v2beta1/{+name}', options) + command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::Empty::Representation + command.response_class = Google::Apis::Adexchangebuyer2V2beta1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the requested filter set for the account with the given account + # ID. + # @param [String] name + # Full name of the resource being requested. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::FilterSet] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::Adexchangebuyer2V2beta1::FilterSet] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_bidder_filter_set(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+name}', options) + command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::FilterSet::Representation + command.response_class = Google::Apis::Adexchangebuyer2V2beta1::FilterSet + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all filter sets for the account with the given account ID. + # @param [String] owner_name + # Name of the owner (bidder or account) of the filter sets to be listed. + # For example: + # - For a bidder-level filter set for bidder 123: `bidders/123` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456` + # @param [Fixnum] page_size + # Requested page size. The server may return fewer results than requested. + # If unspecified, the server will pick an appropriate default. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # ListFilterSetsResponse.nextPageToken + # returned from the previous call to the + # accounts.filterSets.list + # method. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_bidder_filter_sets(owner_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+ownerName}/filterSets', options) + command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse::Representation + command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilterSetsResponse + command.params['ownerName'] = owner_name unless owner_name.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all metrics that are measured in terms of number of bids. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # @param [Fixnum] page_size + # Requested page size. The server may return fewer results than requested. + # If unspecified, the server will pick an appropriate default. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # ListBidMetricsResponse.nextPageToken + # returned from the previous call to the bidMetrics.list + # method. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_bidder_filter_set_bid_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidMetrics', options) + command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse::Representation + command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidMetricsResponse + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # List all errors that occurred in bid responses, with the number of bid + # responses affected for each reason. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # @param [Fixnum] page_size + # Requested page size. The server may return fewer results than requested. + # If unspecified, the server will pick an appropriate default. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # ListBidResponseErrorsResponse.nextPageToken + # returned from the previous call to the bidResponseErrors.list + # method. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_bidder_filter_set_bid_response_errors(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidResponseErrors', options) + command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse::Representation + command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponseErrorsResponse + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # List all reasons for which bid responses were considered to have no + # applicable bids, with the number of bid responses affected for each reason. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # @param [Fixnum] page_size + # Requested page size. The server may return fewer results than requested. + # If unspecified, the server will pick an appropriate default. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # ListBidResponsesWithoutBidsResponse.nextPageToken + # returned from the previous call to the bidResponsesWithoutBids.list + # method. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_bidder_filter_set_bid_responses_without_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/bidResponsesWithoutBids', options) + command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse::Representation + command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListBidResponsesWithoutBidsResponse + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # List all reasons that caused a bid request not to be sent for an + # impression, with the number of bid requests not sent for each reason. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # @param [Fixnum] page_size + # Requested page size. The server may return fewer results than requested. + # If unspecified, the server will pick an appropriate default. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # ListFilteredBidRequestsResponse.nextPageToken + # returned from the previous call to the filteredBidRequests.list + # method. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_bidder_filter_set_filtered_bid_requests(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBidRequests', options) + command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse::Representation + command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidRequestsResponse + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # List all reasons for which bids were filtered, with the number of bids + # filtered for each reason. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # @param [Fixnum] page_size + # Requested page size. The server may return fewer results than requested. + # If unspecified, the server will pick an appropriate default. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # ListFilteredBidsResponse.nextPageToken + # returned from the previous call to the filteredBids.list + # method. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_bidder_filter_set_filtered_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids', options) + command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse::Representation + command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListFilteredBidsResponse + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # List all creatives associated with a specific reason for which bids were + # filtered, with the number of bids filtered for each creative. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # @param [Fixnum] creative_status_id + # The ID of the creative status for which to retrieve a breakdown by + # creative. + # See + # [creative-status-codes](https://developers.google.com/ad-exchange/rtb/ + # downloads/creative-status-codes). + # @param [Fixnum] page_size + # Requested page size. The server may return fewer results than requested. + # If unspecified, the server will pick an appropriate default. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # ListCreativeStatusBreakdownByCreativeResponse.nextPageToken + # returned from the previous call to the filteredBids.creatives.list + # method. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_bidder_filter_set_filtered_bid_creatives(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives', options) + command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse::Representation + command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByCreativeResponse + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? + command.params['creativeStatusId'] = creative_status_id unless creative_status_id.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # List all details associated with a specific reason for which bids were + # filtered, with the number of bids filtered for each detail. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # @param [Fixnum] creative_status_id + # The ID of the creative status for which to retrieve a breakdown by detail. + # See + # [creative-status-codes](https://developers.google.com/ad-exchange/rtb/ + # downloads/creative-status-codes). + # Details are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87. + # @param [Fixnum] page_size + # Requested page size. The server may return fewer results than requested. + # If unspecified, the server will pick an appropriate default. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # ListCreativeStatusBreakdownByDetailResponse.nextPageToken + # returned from the previous call to the filteredBids.details.list + # method. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_bidder_filter_set_filtered_bid_details(filter_set_name, creative_status_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details', options) + command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse::Representation + command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListCreativeStatusBreakdownByDetailResponse + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? + command.params['creativeStatusId'] = creative_status_id unless creative_status_id.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all metrics that are measured in terms of number of impressions. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # @param [Fixnum] page_size + # Requested page size. The server may return fewer results than requested. + # If unspecified, the server will pick an appropriate default. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # ListImpressionMetricsResponse.nextPageToken + # returned from the previous call to the impressionMetrics.list + # method. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_bidder_filter_set_impression_metrics(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/impressionMetrics', options) + command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse::Representation + command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListImpressionMetricsResponse + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # List all reasons for which bids lost in the auction, with the number of + # bids that lost for each reason. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # @param [Fixnum] page_size + # Requested page size. The server may return fewer results than requested. + # If unspecified, the server will pick an appropriate default. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # ListLosingBidsResponse.nextPageToken + # returned from the previous call to the losingBids.list + # method. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_bidder_filter_set_losing_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/losingBids', options) + command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse::Representation + command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListLosingBidsResponse + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # List all reasons for which winning bids were not billable, with the number + # of bids not billed for each reason. + # @param [String] filter_set_name + # Name of the filter set that should be applied to the requested metrics. + # For example: + # - For a bidder-level filter set for bidder 123: + # `bidders/123/filterSets/abc` + # - For an account-level filter set for the buyer account representing bidder + # 123: `bidders/123/accounts/123/filterSets/abc` + # - For an account-level filter set for the child seat buyer account 456 + # whose bidder is 123: `bidders/123/accounts/456/filterSets/abc` + # @param [Fixnum] page_size + # Requested page size. The server may return fewer results than requested. + # If unspecified, the server will pick an appropriate default. + # @param [String] page_token + # A token identifying a page of results the server should return. + # Typically, this is the value of + # ListNonBillableWinningBidsResponse.nextPageToken + # returned from the previous call to the nonBillableWinningBids.list + # method. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_bidder_filter_set_non_billable_winning_bids(filter_set_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+filterSetName}/nonBillableWinningBids', options) + command.response_representation = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse::Representation + command.response_class = Google::Apis::Adexchangebuyer2V2beta1::ListNonBillableWinningBidsResponse + command.params['filterSetName'] = filter_set_name unless filter_set_name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? diff --git a/generated/google/apis/admin_directory_v1.rb b/generated/google/apis/admin_directory_v1.rb index e40020645..7341c6ee3 100644 --- a/generated/google/apis/admin_directory_v1.rb +++ b/generated/google/apis/admin_directory_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/admin-sdk/directory/ module AdminDirectoryV1 VERSION = 'DirectoryV1' - REVISION = '20170830' + REVISION = '20171113' # View and manage customer related information AUTH_ADMIN_DIRECTORY_CUSTOMER = 'https://www.googleapis.com/auth/admin.directory.customer' diff --git a/generated/google/apis/admin_directory_v1/classes.rb b/generated/google/apis/admin_directory_v1/classes.rb index 0cc717f8e..6392fdc83 100644 --- a/generated/google/apis/admin_directory_v1/classes.rb +++ b/generated/google/apis/admin_directory_v1/classes.rb @@ -96,6 +96,73 @@ module Google end end + # JSON template for App Access Collections Resource object in Directory API. + class AppAccessCollections + include Google::Apis::Core::Hashable + + # List of blocked api access buckets. + # Corresponds to the JSON property `blockedApiAccessBuckets` + # @return [Array] + attr_accessor :blocked_api_access_buckets + + # Boolean to indicate whether to enforce app access settings on Android Drive or + # not. + # Corresponds to the JSON property `enforceSettingsForAndroidDrive` + # @return [Boolean] + attr_accessor :enforce_settings_for_android_drive + alias_method :enforce_settings_for_android_drive?, :enforce_settings_for_android_drive + + # Error message provided by the Admin that will be shown to the user when an app + # is blocked. + # Corresponds to the JSON property `errorMessage` + # @return [String] + attr_accessor :error_message + + # ETag of the resource. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # Identifies the resource as an app access collection. Value: admin#directory# + # appaccesscollection + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Unique ID of app access collection. (Readonly) + # Corresponds to the JSON property `resourceId` + # @return [Fixnum] + attr_accessor :resource_id + + # Resource name given by the customer while creating/updating. Should be unique + # under given customer. + # Corresponds to the JSON property `resourceName` + # @return [String] + attr_accessor :resource_name + + # Boolean that indicates whether to trust domain owned apps. + # Corresponds to the JSON property `trustDomainOwnedApps` + # @return [Boolean] + attr_accessor :trust_domain_owned_apps + alias_method :trust_domain_owned_apps?, :trust_domain_owned_apps + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @blocked_api_access_buckets = args[:blocked_api_access_buckets] if args.key?(:blocked_api_access_buckets) + @enforce_settings_for_android_drive = args[:enforce_settings_for_android_drive] if args.key?(:enforce_settings_for_android_drive) + @error_message = args[:error_message] if args.key?(:error_message) + @etag = args[:etag] if args.key?(:etag) + @kind = args[:kind] if args.key?(:kind) + @resource_id = args[:resource_id] if args.key?(:resource_id) + @resource_name = args[:resource_name] if args.key?(:resource_name) + @trust_domain_owned_apps = args[:trust_domain_owned_apps] if args.key?(:trust_domain_owned_apps) + end + end + # The template that returns individual ASP (Access Code) data. class Asp include Google::Apis::Core::Hashable @@ -1181,6 +1248,26 @@ module Google end end + # JSON template for Has Member response in Directory API. + class MembersHasMember + include Google::Apis::Core::Hashable + + # Identifies whether given user is a member or not. + # Corresponds to the JSON property `isMember` + # @return [Boolean] + attr_accessor :is_member + alias_method :is_member?, :is_member + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @is_member = args[:is_member] if args.key?(:is_member) + end + end + # JSON template for Mobile Device resource in Directory API. class MobileDevice include Google::Apis::Core::Hashable @@ -2328,6 +2415,86 @@ module Google end end + # JSON template for Trusted App Ids Resource object in Directory API. + class TrustedAppId + include Google::Apis::Core::Hashable + + # Android package name. + # Corresponds to the JSON property `androidPackageName` + # @return [String] + attr_accessor :android_package_name + + # SHA1 signature of the app certificate. + # Corresponds to the JSON property `certificateHashSHA1` + # @return [String] + attr_accessor :certificate_hash_sha1 + + # SHA256 signature of the app certificate. + # Corresponds to the JSON property `certificateHashSHA256` + # @return [String] + attr_accessor :certificate_hash_sha256 + + # + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # Identifies the resource as a trusted AppId. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @android_package_name = args[:android_package_name] if args.key?(:android_package_name) + @certificate_hash_sha1 = args[:certificate_hash_sha1] if args.key?(:certificate_hash_sha1) + @certificate_hash_sha256 = args[:certificate_hash_sha256] if args.key?(:certificate_hash_sha256) + @etag = args[:etag] if args.key?(:etag) + @kind = args[:kind] if args.key?(:kind) + end + end + + # JSON template for Trusted Apps response object of a user in Directory API. + class TrustedApps + include Google::Apis::Core::Hashable + + # ETag of the resource. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # Identifies the resource as trusted apps response. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Trusted Apps list. + # Corresponds to the JSON property `trustedApps` + # @return [Array] + attr_accessor :trusted_apps + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @trusted_apps = args[:trusted_apps] if args.key?(:trusted_apps) + end + end + # JSON template for User object in Directory API. class User include Google::Apis::Core::Hashable @@ -3265,6 +3432,11 @@ module Google class UserPosixAccount include Google::Apis::Core::Hashable + # A POSIX account field identifier. (Read-only) + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + # The GECOS (user information) for this account. # Corresponds to the JSON property `gecos` # @return [String] @@ -3312,6 +3484,7 @@ module Google # Update properties of this object def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) @gecos = args[:gecos] if args.key?(:gecos) @gid = args[:gid] if args.key?(:gid) @home_directory = args[:home_directory] if args.key?(:home_directory) diff --git a/generated/google/apis/admin_directory_v1/representations.rb b/generated/google/apis/admin_directory_v1/representations.rb index 72a5fda13..91e830a28 100644 --- a/generated/google/apis/admin_directory_v1/representations.rb +++ b/generated/google/apis/admin_directory_v1/representations.rb @@ -34,6 +34,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class AppAccessCollections + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Asp class Representation < Google::Apis::Core::JsonRepresentation; end @@ -160,6 +166,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class MembersHasMember + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class MobileDevice class Representation < Google::Apis::Core::JsonRepresentation; end @@ -286,6 +298,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class TrustedAppId + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TrustedApps + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class User class Representation < Google::Apis::Core::JsonRepresentation; end @@ -444,6 +468,20 @@ module Google end end + class AppAccessCollections + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :blocked_api_access_buckets, as: 'blockedApiAccessBuckets' + property :enforce_settings_for_android_drive, as: 'enforceSettingsForAndroidDrive' + property :error_message, as: 'errorMessage' + property :etag, as: 'etag' + property :kind, as: 'kind' + property :resource_id, :numeric_string => true, as: 'resourceId' + property :resource_name, as: 'resourceName' + property :trust_domain_owned_apps, as: 'trustDomainOwnedApps' + end + end + class Asp # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -716,6 +754,13 @@ module Google end end + class MembersHasMember + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :is_member, as: 'isMember' + end + end + class MobileDevice # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -998,6 +1043,28 @@ module Google end end + class TrustedAppId + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :android_package_name, as: 'androidPackageName' + property :certificate_hash_sha1, as: 'certificateHashSHA1' + property :certificate_hash_sha256, as: 'certificateHashSHA256' + property :etag, as: 'etag' + property :kind, as: 'kind' + end + end + + class TrustedApps + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :trusted_apps, as: 'trustedApps', class: Google::Apis::AdminDirectoryV1::TrustedAppId, decorator: Google::Apis::AdminDirectoryV1::TrustedAppId::Representation + + end + end + class User # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1209,6 +1276,7 @@ module Google class UserPosixAccount # @private class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' property :gecos, as: 'gecos' property :gid, :numeric_string => true, as: 'gid' property :home_directory, as: 'homeDirectory' diff --git a/generated/google/apis/admin_directory_v1/service.rb b/generated/google/apis/admin_directory_v1/service.rb index aad0129d9..869f2eade 100644 --- a/generated/google/apis/admin_directory_v1/service.rb +++ b/generated/google/apis/admin_directory_v1/service.rb @@ -287,7 +287,7 @@ module Google # @param [String] order_by # Column to use for sorting results # @param [String] org_unit_path - # Full path of the organization unit or its Id + # Full path of the organizational unit or its ID # @param [String] page_token # Token to specify next page in the list # @param [String] projection @@ -337,11 +337,11 @@ module Google execute_or_queue_command(command, &block) end - # Move or insert multiple Chrome OS Devices to Organization Unit + # Move or insert multiple Chrome OS Devices to organizational unit # @param [String] customer_id # Immutable ID of the G Suite account # @param [String] org_unit_path - # Full path of the target organization unit or its Id + # Full path of the target organizational unit or its ID # @param [Google::Apis::AdminDirectoryV1::ChromeOsMoveDevicesToOu] chrome_os_move_devices_to_ou_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -874,7 +874,7 @@ module Google # Delete Group # @param [String] group_key - # Email or immutable Id of the group + # Email or immutable ID of the group # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -907,7 +907,7 @@ module Google # Retrieve Group # @param [String] group_key - # Email or immutable Id of the group + # Email or immutable ID of the group # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -987,8 +987,8 @@ module Google # @param [String] page_token # Token to specify next page in the list # @param [String] user_key - # Email or immutable Id of the user if only those groups are to be listed, the - # given user is a member of. If Id, it should match with id of user object + # Email or immutable ID of the user if only those groups are to be listed, the + # given user is a member of. If ID, it should match with id of user object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1027,7 +1027,7 @@ module Google # Update Group. This method supports patch semantics. # @param [String] group_key - # Email or immutable Id of the group. If Id, it should match with id of group + # Email or immutable ID of the group. If ID, it should match with id of group # object # @param [Google::Apis::AdminDirectoryV1::Group] group_object # @param [String] fields @@ -1066,7 +1066,7 @@ module Google # Update Group # @param [String] group_key - # Email or immutable Id of the group. If Id, it should match with id of group + # Email or immutable ID of the group. If ID, it should match with id of group # object # @param [Google::Apis::AdminDirectoryV1::Group] group_object # @param [String] fields @@ -1105,7 +1105,7 @@ module Google # Remove a alias for the group # @param [String] group_key - # Email or immutable Id of the group + # Email or immutable ID of the group # @param [String] group_alias # The alias to be removed # @param [String] fields @@ -1141,7 +1141,7 @@ module Google # Add a alias for the group # @param [String] group_key - # Email or immutable Id of the group + # Email or immutable ID of the group # @param [Google::Apis::AdminDirectoryV1::Alias] alias_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1179,7 +1179,7 @@ module Google # List all aliases for a group # @param [String] group_key - # Email or immutable Id of the group + # Email or immutable ID of the group # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1214,9 +1214,9 @@ module Google # Remove membership. # @param [String] group_key - # Email or immutable Id of the group + # Email or immutable ID of the group # @param [String] member_key - # Email or immutable Id of the member + # Email or immutable ID of the member # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1250,9 +1250,9 @@ module Google # Retrieve Group Member # @param [String] group_key - # Email or immutable Id of the group + # Email or immutable ID of the group # @param [String] member_key - # Email or immutable Id of the member + # Email or immutable ID of the member # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1286,9 +1286,47 @@ module Google execute_or_queue_command(command, &block) end - # Add user to the specified group. + # Checks Membership of an user within a Group # @param [String] group_key # Email or immutable Id of the group + # @param [String] member_key + # Email or immutable Id of the member + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AdminDirectoryV1::MembersHasMember] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AdminDirectoryV1::MembersHasMember] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def has_member_member(group_key, member_key, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'groups/{groupKey}/hasMember/{memberKey}', options) + command.response_representation = Google::Apis::AdminDirectoryV1::MembersHasMember::Representation + command.response_class = Google::Apis::AdminDirectoryV1::MembersHasMember + command.params['groupKey'] = group_key unless group_key.nil? + command.params['memberKey'] = member_key unless member_key.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Add user to the specified group. + # @param [String] group_key + # Email or immutable ID of the group # @param [Google::Apis::AdminDirectoryV1::Member] member_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1326,7 +1364,7 @@ module Google # Retrieve all members in a group (paginated) # @param [String] group_key - # Email or immutable Id of the group + # Email or immutable ID of the group # @param [Fixnum] max_results # Maximum number of results to return. Default is 200 # @param [String] page_token @@ -1371,10 +1409,10 @@ module Google # Update membership of a user in the specified group. This method supports patch # semantics. # @param [String] group_key - # Email or immutable Id of the group. If Id, it should match with id of group + # Email or immutable ID of the group. If ID, it should match with id of group # object # @param [String] member_key - # Email or immutable Id of the user. If Id, it should match with id of member + # Email or immutable ID of the user. If ID, it should match with id of member # object # @param [Google::Apis::AdminDirectoryV1::Member] member_object # @param [String] fields @@ -1414,10 +1452,10 @@ module Google # Update membership of a user in the specified group. # @param [String] group_key - # Email or immutable Id of the group. If Id, it should match with id of group + # Email or immutable ID of the group. If ID, it should match with id of group # object # @param [String] member_key - # Email or immutable Id of the user. If Id, it should match with id of member + # Email or immutable ID of the user. If ID, it should match with id of member # object # @param [Google::Apis::AdminDirectoryV1::Member] member_object # @param [String] fields @@ -1829,11 +1867,11 @@ module Google execute_or_queue_command(command, &block) end - # Remove Organization Unit + # Remove organizational unit # @param [String] customer_id # Immutable ID of the G Suite account # @param [Array, String] org_unit_path - # Full path of the organization unit or its Id + # Full path of the organizational unit or its ID # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1865,11 +1903,11 @@ module Google execute_or_queue_command(command, &block) end - # Retrieve Organization Unit + # Retrieve organizational unit # @param [String] customer_id # Immutable ID of the G Suite account # @param [Array, String] org_unit_path - # Full path of the organization unit or its Id + # Full path of the organizational unit or its ID # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1903,7 +1941,7 @@ module Google execute_or_queue_command(command, &block) end - # Add Organization Unit + # Add organizational unit # @param [String] customer_id # Immutable ID of the G Suite account # @param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_object @@ -1941,11 +1979,11 @@ module Google execute_or_queue_command(command, &block) end - # Retrieve all Organization Units + # Retrieve all organizational units # @param [String] customer_id # Immutable ID of the G Suite account # @param [String] org_unit_path - # the URL-encoded organization unit's path or its Id + # the URL-encoded organizational unit's path or its ID # @param [String] type # Whether to return all sub-organizations or just immediate children # @param [String] fields @@ -1982,11 +2020,11 @@ module Google execute_or_queue_command(command, &block) end - # Update Organization Unit. This method supports patch semantics. + # Update organizational unit. This method supports patch semantics. # @param [String] customer_id # Immutable ID of the G Suite account # @param [Array, String] org_unit_path - # Full path of the organization unit or its Id + # Full path of the organizational unit or its ID # @param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2023,11 +2061,11 @@ module Google execute_or_queue_command(command, &block) end - # Update Organization Unit + # Update organizational unit # @param [String] customer_id # Immutable ID of the G Suite account # @param [Array, String] org_unit_path - # Full path of the organization unit or its Id + # Full path of the organizational unit or its ID # @param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2099,6 +2137,70 @@ module Google execute_or_queue_command(command, &block) end + # Retrieves resolved app access settings of the logged in user. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AdminDirectoryV1::AppAccessCollections] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AdminDirectoryV1::AppAccessCollections] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_resolved_app_access_setting_settings(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'resolvedappaccesssettings', options) + command.response_representation = Google::Apis::AdminDirectoryV1::AppAccessCollections::Representation + command.response_class = Google::Apis::AdminDirectoryV1::AppAccessCollections + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of apps trusted by the admin of the logged in user. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AdminDirectoryV1::TrustedApps] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AdminDirectoryV1::TrustedApps] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_resolved_app_access_setting_trusted_apps(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'trustedapps', options) + command.response_representation = Google::Apis::AdminDirectoryV1::TrustedApps::Representation + command.response_class = Google::Apis::AdminDirectoryV1::TrustedApps + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Deletes a calendar resource. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, @@ -2256,7 +2358,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates a calendar resource. This method supports patch semantics. + # Updates a calendar resource. + # This method supports patch semantics, meaning you only need to include the + # fields you wish to update. Fields that are not present in the request will be + # preserved. This method supports patch semantics. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, # you can also use the my_customer alias to represent your account's customer ID. @@ -2299,6 +2404,9 @@ module Google end # Updates a calendar resource. + # This method supports patch semantics, meaning you only need to include the + # fields you wish to update. Fields that are not present in the request will be + # preserved. # @param [String] customer # The unique ID for the customer's G Suite account. As an account administrator, # you can also use the my_customer alias to represent your account's customer ID. @@ -2740,7 +2848,7 @@ module Google # @param [String] customer_id # Immutable ID of the G Suite account # @param [String] schema_key - # Name or immutable Id of the schema + # Name or immutable ID of the schema # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2776,7 +2884,7 @@ module Google # @param [String] customer_id # Immutable ID of the G Suite account # @param [String] schema_key - # Name or immutable Id of the schema + # Name or immutable ID of the schema # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2887,7 +2995,7 @@ module Google # @param [String] customer_id # Immutable ID of the G Suite account # @param [String] schema_key - # Name or immutable Id of the schema. + # Name or immutable ID of the schema. # @param [Google::Apis::AdminDirectoryV1::Schema] schema_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2928,7 +3036,7 @@ module Google # @param [String] customer_id # Immutable ID of the G Suite account # @param [String] schema_key - # Name or immutable Id of the schema. + # Name or immutable ID of the schema. # @param [Google::Apis::AdminDirectoryV1::Schema] schema_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3079,7 +3187,7 @@ module Google # Delete user # @param [String] user_key - # Email or immutable Id of the user + # Email or immutable ID of the user # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3112,7 +3220,7 @@ module Google # retrieve user # @param [String] user_key - # Email or immutable Id of the user + # Email or immutable ID of the user # @param [String] custom_field_mask # Comma-separated list of schema names. All fields from these schemas are # fetched. This should only be set when projection=custom. @@ -3264,7 +3372,7 @@ module Google # change admin status of a user # @param [String] user_key - # Email or immutable Id of the user as admin + # Email or immutable ID of the user as admin # @param [Google::Apis::AdminDirectoryV1::UserMakeAdmin] user_make_admin_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3300,7 +3408,7 @@ module Google # update user. This method supports patch semantics. # @param [String] user_key - # Email or immutable Id of the user. If Id, it should match with id of user + # Email or immutable ID of the user. If ID, it should match with id of user # object # @param [Google::Apis::AdminDirectoryV1::User] user_object # @param [String] fields @@ -3375,7 +3483,7 @@ module Google # update user # @param [String] user_key - # Email or immutable Id of the user. If Id, it should match with id of user + # Email or immutable ID of the user. If ID, it should match with id of user # object # @param [Google::Apis::AdminDirectoryV1::User] user_object # @param [String] fields @@ -3489,7 +3597,7 @@ module Google # Remove a alias for the user # @param [String] user_key - # Email or immutable Id of the user + # Email or immutable ID of the user # @param [String] user_alias # The alias to be removed # @param [String] fields @@ -3525,7 +3633,7 @@ module Google # Add a alias for the user # @param [String] user_key - # Email or immutable Id of the user + # Email or immutable ID of the user # @param [Google::Apis::AdminDirectoryV1::Alias] alias_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3563,7 +3671,7 @@ module Google # List all aliases for a user # @param [String] user_key - # Email or immutable Id of the user + # Email or immutable ID of the user # @param [String] event # Event on which subscription is intended (if subscribing) # @param [String] fields @@ -3601,7 +3709,7 @@ module Google # Watch for changes in user aliases list # @param [String] user_key - # Email or immutable Id of the user + # Email or immutable ID of the user # @param [Google::Apis::AdminDirectoryV1::Channel] channel_object # @param [String] event # Event on which subscription is intended (if subscribing) @@ -3642,7 +3750,7 @@ module Google # Remove photos for the user # @param [String] user_key - # Email or immutable Id of the user + # Email or immutable ID of the user # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3675,7 +3783,7 @@ module Google # Retrieve photo of a user # @param [String] user_key - # Email or immutable Id of the user + # Email or immutable ID of the user # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3710,7 +3818,7 @@ module Google # Add a photo for the user. This method supports patch semantics. # @param [String] user_key - # Email or immutable Id of the user + # Email or immutable ID of the user # @param [Google::Apis::AdminDirectoryV1::UserPhoto] user_photo_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3748,7 +3856,7 @@ module Google # Add a photo for the user # @param [String] user_key - # Email or immutable Id of the user + # Email or immutable ID of the user # @param [Google::Apis::AdminDirectoryV1::UserPhoto] user_photo_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3786,7 +3894,7 @@ module Google # Generate new backup verification codes for the user. # @param [String] user_key - # Email or immutable Id of the user + # Email or immutable ID of the user # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3819,7 +3927,7 @@ module Google # Invalidate the current backup verification codes for the user. # @param [String] user_key - # Email or immutable Id of the user + # Email or immutable ID of the user # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/analyticsreporting_v4.rb b/generated/google/apis/analyticsreporting_v4.rb index f8b60ed6d..98da91277 100644 --- a/generated/google/apis/analyticsreporting_v4.rb +++ b/generated/google/apis/analyticsreporting_v4.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/analytics/devguides/reporting/core/v4/ module AnalyticsreportingV4 VERSION = 'V4' - REVISION = '20170925' + REVISION = '20171108' # View and manage your Google Analytics data AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics' diff --git a/generated/google/apis/analyticsreporting_v4/classes.rb b/generated/google/apis/analyticsreporting_v4/classes.rb index bcecadbdc..4584093b0 100644 --- a/generated/google/apis/analyticsreporting_v4/classes.rb +++ b/generated/google/apis/analyticsreporting_v4/classes.rb @@ -376,6 +376,21 @@ module Google # @return [Array] attr_accessor :report_requests + # Enables + # [resource based quotas](/analytics/devguides/reporting/core/v4/limits-quotas# + # analytics_reporting_api_v4), + # (defaults to `False`). If this field is set to `True` the + # per view (profile) quotas are governed by the computational + # cost of the request. Note that using cost based quotas will + # higher enable sampling rates. (10 Million for `SMALL`, + # 100M for `LARGE`. See the + # [limits and quotas documentation](/analytics/devguides/reporting/core/v4/ + # limits-quotas#analytics_reporting_api_v4) for details. + # Corresponds to the JSON property `useResourceQuotas` + # @return [Boolean] + attr_accessor :use_resource_quotas + alias_method :use_resource_quotas?, :use_resource_quotas + def initialize(**args) update!(**args) end @@ -383,6 +398,7 @@ module Google # Update properties of this object def update!(**args) @report_requests = args[:report_requests] if args.key?(:report_requests) + @use_resource_quotas = args[:use_resource_quotas] if args.key?(:use_resource_quotas) end end @@ -391,18 +407,32 @@ module Google class GetReportsResponse include Google::Apis::Core::Hashable + # The amount of resource quota tokens deducted to execute the query. Includes + # all responses. + # Corresponds to the JSON property `queryCost` + # @return [Fixnum] + attr_accessor :query_cost + # Responses corresponding to each of the request. # Corresponds to the JSON property `reports` # @return [Array] attr_accessor :reports + # The resource quota tokens remaining for the property after the request is + # completed. + # Corresponds to the JSON property `resourceQuotasRemaining` + # @return [Google::Apis::AnalyticsreportingV4::ResourceQuotasRemaining] + attr_accessor :resource_quotas_remaining + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @query_cost = args[:query_cost] if args.key?(:query_cost) @reports = args[:reports] if args.key?(:reports) + @resource_quotas_remaining = args[:resource_quotas_remaining] if args.key?(:resource_quotas_remaining) end end @@ -1103,6 +1133,32 @@ module Google end end + # The resource quota tokens remaining for the property after the request is + # completed. + class ResourceQuotasRemaining + include Google::Apis::Core::Hashable + + # Daily resource quota remaining remaining. + # Corresponds to the JSON property `dailyQuotaTokensRemaining` + # @return [Fixnum] + attr_accessor :daily_quota_tokens_remaining + + # Hourly resource quota tokens remaining. + # Corresponds to the JSON property `hourlyQuotaTokensRemaining` + # @return [Fixnum] + attr_accessor :hourly_quota_tokens_remaining + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @daily_quota_tokens_remaining = args[:daily_quota_tokens_remaining] if args.key?(:daily_quota_tokens_remaining) + @hourly_quota_tokens_remaining = args[:hourly_quota_tokens_remaining] if args.key?(:hourly_quota_tokens_remaining) + end + end + # The segment definition, if the report needs to be segmented. # A Segment is a subset of the Analytics data. For example, of the entire # set of users, one Segment might be users from a particular country or city. diff --git a/generated/google/apis/analyticsreporting_v4/representations.rb b/generated/google/apis/analyticsreporting_v4/representations.rb index 7d3033855..643a2e91a 100644 --- a/generated/google/apis/analyticsreporting_v4/representations.rb +++ b/generated/google/apis/analyticsreporting_v4/representations.rb @@ -178,6 +178,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ResourceQuotasRemaining + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Segment class Representation < Google::Apis::Core::JsonRepresentation; end @@ -321,14 +327,18 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :report_requests, as: 'reportRequests', class: Google::Apis::AnalyticsreportingV4::ReportRequest, decorator: Google::Apis::AnalyticsreportingV4::ReportRequest::Representation + property :use_resource_quotas, as: 'useResourceQuotas' end end class GetReportsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation + property :query_cost, as: 'queryCost' collection :reports, as: 'reports', class: Google::Apis::AnalyticsreportingV4::Report, decorator: Google::Apis::AnalyticsreportingV4::Report::Representation + property :resource_quotas_remaining, as: 'resourceQuotasRemaining', class: Google::Apis::AnalyticsreportingV4::ResourceQuotasRemaining, decorator: Google::Apis::AnalyticsreportingV4::ResourceQuotasRemaining::Representation + end end @@ -506,6 +516,14 @@ module Google end end + class ResourceQuotasRemaining + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :daily_quota_tokens_remaining, as: 'dailyQuotaTokensRemaining' + property :hourly_quota_tokens_remaining, as: 'hourlyQuotaTokensRemaining' + end + end + class Segment # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/androiddeviceprovisioning_v1.rb b/generated/google/apis/androiddeviceprovisioning_v1.rb index 7f6ea6088..6e191fa3d 100644 --- a/generated/google/apis/androiddeviceprovisioning_v1.rb +++ b/generated/google/apis/androiddeviceprovisioning_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/zero-touch/ module AndroiddeviceprovisioningV1 VERSION = 'V1' - REVISION = '20170916' + REVISION = '20171118' end end end diff --git a/generated/google/apis/androiddeviceprovisioning_v1/classes.rb b/generated/google/apis/androiddeviceprovisioning_v1/classes.rb index 70551c085..ed48f4704 100644 --- a/generated/google/apis/androiddeviceprovisioning_v1/classes.rb +++ b/generated/google/apis/androiddeviceprovisioning_v1/classes.rb @@ -31,7 +31,8 @@ module Google # @return [Fixnum] attr_accessor :customer_id - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier @@ -167,37 +168,45 @@ module Google end end - # An Android device. + # An Android device registered for zero-touch enrollment. class Device include Google::Apis::Core::Hashable - # Claims. + # Output only. The provisioning claims for a device. Devices claimed for + # zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. + # Call + # `partners.devices.unclaim` + # or + # `partners.devices.unclaimAsync` + # to remove the device from zero-touch enrollment. # Corresponds to the JSON property `claims` # @return [Array] attr_accessor :claims - # The resource name of the configuration. - # Only set for customers. + # Not available to resellers. # Corresponds to the JSON property `configuration` # @return [String] attr_accessor :configuration - # Device ID. + # Output only. The ID of the device. Assigned by the server. # Corresponds to the JSON property `deviceId` # @return [Fixnum] attr_accessor :device_id - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier - # A key-value pair of the device metadata. + # Metadata entries that can be attached to a `Device`. To learn more, read + # [Device metadata](/zero-touch/guides/metadata). # Corresponds to the JSON property `deviceMetadata` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata] attr_accessor :device_metadata - # Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. + # Output only. The API resource name in the format + # `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -217,16 +226,19 @@ module Google end end - # Information about a device claimed for a partner. + # A record of a device claimed by a reseller for a customer. Devices claimed + # for zero-touch enrollment have a claim with the type + # `SECTION_TYPE_ZERO_TOUCH`. To learn more, read + # [Claim devices for customers](/zero-touch/guides/how-it-works#claim). class DeviceClaim include Google::Apis::Core::Hashable - # Owner ID. + # The ID of the Customer that purchased the device. # Corresponds to the JSON property `ownerCompanyId` # @return [Fixnum] attr_accessor :owner_company_id - # Section type of the device claim. + # Output only. The type of claim made on the device. # Corresponds to the JSON property `sectionType` # @return [String] attr_accessor :section_type @@ -242,28 +254,30 @@ module Google end end - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). class DeviceIdentifier include Google::Apis::Core::Hashable - # IMEI number. + # The device’s IMEI number. Validated on input. # Corresponds to the JSON property `imei` # @return [String] attr_accessor :imei - # Manufacturer name to match `android.os.Build.MANUFACTURER` (required). - # Allowed values listed in - # [manufacturer names](/zero-touch/resources/manufacturer-names). + # Required. The device manufacturer’s name. Matches the device's built-in + # value returned from `android.os.Build.MANUFACTURER`. Allowed values are + # listed in [manufacturer names](/zero-touch/resources/manufacturer-names). # Corresponds to the JSON property `manufacturer` # @return [String] attr_accessor :manufacturer - # MEID number. + # The device’s MEID number. # Corresponds to the JSON property `meid` # @return [String] attr_accessor :meid - # Serial number (optional). + # The manufacturer's serial number for the device. This value might not be + # unique. # Corresponds to the JSON property `serialNumber` # @return [String] attr_accessor :serial_number @@ -281,11 +295,12 @@ module Google end end - # A key-value pair of the device metadata. + # Metadata entries that can be attached to a `Device`. To learn more, read + # [Device metadata](/zero-touch/guides/metadata). class DeviceMetadata include Google::Apis::Core::Hashable - # Metadata entries + # Metadata entries recorded as key-value pairs. # Corresponds to the JSON property `entries` # @return [Hash] attr_accessor :entries @@ -380,7 +395,8 @@ module Google class FindDevicesByDeviceIdentifierRequest include Google::Apis::Core::Hashable - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier @@ -648,12 +664,14 @@ module Google # @return [Fixnum] attr_accessor :customer_id - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier - # A key-value pair of the device metadata. + # Metadata entries that can be attached to a `Device`. To learn more, read + # [Device metadata](/zero-touch/guides/metadata). # Corresponds to the JSON property `deviceMetadata` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata] attr_accessor :device_metadata @@ -685,7 +703,8 @@ module Google # @return [Fixnum] attr_accessor :device_id - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier @@ -825,7 +844,8 @@ module Google # @return [Fixnum] attr_accessor :device_id - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier @@ -889,7 +909,8 @@ module Google class UpdateDeviceMetadataRequest include Google::Apis::Core::Hashable - # A key-value pair of the device metadata. + # Metadata entries that can be attached to a `Device`. To learn more, read + # [Device metadata](/zero-touch/guides/metadata). # Corresponds to the JSON property `deviceMetadata` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata] attr_accessor :device_metadata @@ -913,12 +934,14 @@ module Google # @return [Fixnum] attr_accessor :device_id - # Identifies a unique device. + # Encapsulates hardware and product IDs to identify a manufactured device. To + # learn more, read [Identifiers](/zero-touch/guides/identifiers). # Corresponds to the JSON property `deviceIdentifier` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier] attr_accessor :device_identifier - # A key-value pair of the device metadata. + # Metadata entries that can be attached to a `Device`. To learn more, read + # [Device metadata](/zero-touch/guides/metadata). # Corresponds to the JSON property `deviceMetadata` # @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata] attr_accessor :device_metadata diff --git a/generated/google/apis/androiddeviceprovisioning_v1/service.rb b/generated/google/apis/androiddeviceprovisioning_v1/service.rb index c4976b74d..4d7a05be7 100644 --- a/generated/google/apis/androiddeviceprovisioning_v1/service.rb +++ b/generated/google/apis/androiddeviceprovisioning_v1/service.rb @@ -85,7 +85,7 @@ module Google # by calling API methods or using their zero-touch enrollment portal. The API # doesn't notify the customer that they have access. # @param [String] parent - # Required. The parent resource ID in format `partners/[PARTNER_ID]` that + # Required. The parent resource ID in the format `partners/[PARTNER_ID]` that # identifies the reseller. # @param [Google::Apis::AndroiddeviceprovisioningV1::CreateCustomerRequest] create_customer_request_object # @param [String] fields diff --git a/generated/google/apis/androidenterprise_v1.rb b/generated/google/apis/androidenterprise_v1.rb index 5fc94f89b..be05a9704 100644 --- a/generated/google/apis/androidenterprise_v1.rb +++ b/generated/google/apis/androidenterprise_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android/work/play/emm-api module AndroidenterpriseV1 VERSION = 'V1' - REVISION = '20170929' + REVISION = '20171108' # Manage corporate Android devices AUTH_ANDROIDENTERPRISE = 'https://www.googleapis.com/auth/androidenterprise' diff --git a/generated/google/apis/androidenterprise_v1/classes.rb b/generated/google/apis/androidenterprise_v1/classes.rb index 842d24ba1..6ecc2d81e 100644 --- a/generated/google/apis/androidenterprise_v1/classes.rb +++ b/generated/google/apis/androidenterprise_v1/classes.rb @@ -409,6 +409,41 @@ module Google end end + # A configuration variables resource contains the managed configuration settings + # ID to be applied to a single user, as well as the variable set that is + # attributed to the user. The variable set will be used to replace placeholders + # in the managed configuration settings. + class ConfigurationVariables + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # androidenterprise#configurationVariables". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The ID of the managed configurations settings. + # Corresponds to the JSON property `mcmId` + # @return [String] + attr_accessor :mcm_id + + # The variable set that is attributed to the user. + # Corresponds to the JSON property `variableSet` + # @return [Array] + attr_accessor :variable_set + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @mcm_id = args[:mcm_id] if args.key?(:mcm_id) + @variable_set = args[:variable_set] if args.key?(:variable_set) + end + end + # A Devices resource represents a mobile device managed by the EMM and belonging # to a specific enterprise user. # This collection cannot be modified via the API. It is automatically populated @@ -737,7 +772,7 @@ module Google # purchases the product in Google Play for the first time. # Use the API to query group licenses. A Grouplicenses resource includes the # total number of licenses purchased (paid apps only) and the total number of - # licenses currently in use. Iyn other words, the total number of Entitlements + # licenses currently in use. In other words, the total number of Entitlements # that exist for the product. # Only one group license object is created per product and group license objects # are never deleted. If a product is unapproved, its group license remains. This @@ -1027,12 +1062,20 @@ module Google end end - # A managed configuration resource contains the set of managed properties that - # have been configured for an Android app. The app's developer would have - # defined configurable properties in the managed configurations schema. + # A managed configuration resource contains the set of managed properties + # defined by the app developer in the app's managed configurations schema, as + # well as any configuration variables defined for the user. class ManagedConfiguration include Google::Apis::Core::Hashable + # A configuration variables resource contains the managed configuration settings + # ID to be applied to a single user, as well as the variable set that is + # attributed to the user. The variable set will be used to replace placeholders + # in the managed configuration settings. + # Corresponds to the JSON property `configurationVariables` + # @return [Google::Apis::AndroidenterpriseV1::ConfigurationVariables] + attr_accessor :configuration_variables + # Identifies what kind of resource this is. Value: the fixed string " # androidenterprise#managedConfiguration". # Corresponds to the JSON property `kind` @@ -1056,6 +1099,7 @@ module Google # Update properties of this object def update!(**args) + @configuration_variables = args[:configuration_variables] if args.key?(:configuration_variables) @kind = args[:kind] if args.key?(:kind) @managed_property = args[:managed_property] if args.key?(:managed_property) @product_id = args[:product_id] if args.key?(:product_id) @@ -1114,6 +1158,74 @@ module Google end end + # A managed configurations settings resource contains the set of managed + # properties that have been configured for an Android app to be applied to a set + # of users. The app's developer would have defined configurable properties in + # the managed configurations schema. + class ManagedConfigurationsSettings + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # androidenterprise#managedConfigurationsSettings". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The set of managed properties for this configuration. + # Corresponds to the JSON property `managedProperty` + # @return [Array] + attr_accessor :managed_property + + # The ID of the managed configurations settings. + # Corresponds to the JSON property `mcmId` + # @return [String] + attr_accessor :mcm_id + + # The name of the managed configurations settings. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @managed_property = args[:managed_property] if args.key?(:managed_property) + @mcm_id = args[:mcm_id] if args.key?(:mcm_id) + @name = args[:name] if args.key?(:name) + end + end + + # The managed configurations settings for a product. + class ManagedConfigurationsSettingsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # androidenterprise#managedConfigurationsSettingsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # A managed configurations settings for an app that may be assigned to a group + # of users in an enterprise. + # Corresponds to the JSON property `managedConfigurationsSettings` + # @return [Array] + attr_accessor :managed_configurations_settings + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @managed_configurations_settings = args[:managed_configurations_settings] if args.key?(:managed_configurations_settings) + end + end + # A managed property of a managed configuration. The property must match one of # the properties in the app restrictions schema of the product. Exactly one of # the value fields must be populated, and it must match the property's type in @@ -1719,12 +1831,11 @@ module Google # @return [String] attr_accessor :product_set_behavior - # Other products that are part of the set, in addition to those specified in the - # productId array. The only difference between this field and the productId - # array is that it's possible to specify additional information about this - # product visibility, see ProductVisibility and its fields for more information. - # Specifying the same product ID both here and in the productId array is not - # allowed and it will result in an error. + # Additional list of product IDs making up the product set. Unlike the productID + # array, in this list It's possible to specify which tracks (alpha, beta, + # production) of a product are visible to the user. See ProductVisibility and + # its fields for more information. Specifying the same product ID both here and + # in the productId array is not allowed and it will result in an error. # Corresponds to the JSON property `productVisibility` # @return [Array] attr_accessor :product_visibility @@ -1773,22 +1884,22 @@ module Google class ProductVisibility include Google::Apis::Core::Hashable - # The product ID that should be made visible to the user. This is required. + # The product ID to make visible to the user. Required for each item in the + # productVisibility list. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id - # This allows to only grant visibility to the specified tracks of the app. For - # example, if an app has a prod version, a beta version and an alpha version and - # the enterprise has been granted visibility to both the alpha and beta tracks, - # if tracks is `"beta", "production"` the user will be able to install the app - # and they will get the beta version of the app. If there are no app versions in - # the specified track or if the enterprise wasn't granted visibility for the - # track, adding the "alpha" and "beta" values to the list of tracks will have no - # effect for now; however they will take effect once both conditions are met. - # Note that the enterprise itself needs to be granted access to the alpha and/or - # beta tracks, regardless of whether individual users or admins have access to - # those tracks. + # Grants visibility to the specified track(s) of the product to the user. The + # track available to the user is based on the following order of preference: + # alpha, beta, production. For example, if an app has a prod version, a beta + # version and an alpha version and the enterprise has been granted visibility to + # both the alpha and beta tracks, if tracks is `"beta", "production"` the user + # will be able to install the app and they will get the beta version of the app. + # If there are no app versions in the specified track adding the "alpha" and " + # beta" values to the list of tracks will have no effect. Note that the + # enterprise requires access to alpha and/or beta tracks before users can be + # granted visibility to apps in those tracks. # The allowed sets are: `` (considered equivalent to `"production"`) `" # production"` `"beta", "production"` `"alpha", "beta", "production"` The order # of elements is not relevant. Any other set of tracks will be rejected with an @@ -2390,6 +2501,41 @@ module Google @user = args[:user] if args.key?(:user) end end + + # A variable set is a key-value pair of EMM-provided placeholders and its + # corresponding value, which is attributed to a user. For example, $FIRSTNAME + # could be a placeholder, and its value could be Alice. Placeholders should + # start with a '$' sign and should be alphanumeric only. + class VariableSet + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # androidenterprise#variableSet". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The placeholder string; defined by EMM. + # Corresponds to the JSON property `placeholder` + # @return [String] + attr_accessor :placeholder + + # The value of the placeholder, specific to the user. + # Corresponds to the JSON property `userValue` + # @return [String] + attr_accessor :user_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @placeholder = args[:placeholder] if args.key?(:placeholder) + @user_value = args[:user_value] if args.key?(:user_value) + end + end end end end diff --git a/generated/google/apis/androidenterprise_v1/representations.rb b/generated/google/apis/androidenterprise_v1/representations.rb index c7977ed49..1a20b9a0f 100644 --- a/generated/google/apis/androidenterprise_v1/representations.rb +++ b/generated/google/apis/androidenterprise_v1/representations.rb @@ -94,6 +94,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ConfigurationVariables + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Device class Representation < Google::Apis::Core::JsonRepresentation; end @@ -208,6 +214,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ManagedConfigurationsSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ManagedConfigurationsSettingsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ManagedProperty class Representation < Google::Apis::Core::JsonRepresentation; end @@ -400,6 +418,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class VariableSet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Administrator # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -507,6 +531,16 @@ module Google end end + class ConfigurationVariables + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :mcm_id, as: 'mcmId' + collection :variable_set, as: 'variableSet', class: Google::Apis::AndroidenterpriseV1::VariableSet, decorator: Google::Apis::AndroidenterpriseV1::VariableSet::Representation + + end + end + class Device # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -660,6 +694,8 @@ module Google class ManagedConfiguration # @private class Representation < Google::Apis::Core::JsonRepresentation + property :configuration_variables, as: 'configurationVariables', class: Google::Apis::AndroidenterpriseV1::ConfigurationVariables, decorator: Google::Apis::AndroidenterpriseV1::ConfigurationVariables::Representation + property :kind, as: 'kind' collection :managed_property, as: 'managedProperty', class: Google::Apis::AndroidenterpriseV1::ManagedProperty, decorator: Google::Apis::AndroidenterpriseV1::ManagedProperty::Representation @@ -685,6 +721,26 @@ module Google end end + class ManagedConfigurationsSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :managed_property, as: 'managedProperty', class: Google::Apis::AndroidenterpriseV1::ManagedProperty, decorator: Google::Apis::AndroidenterpriseV1::ManagedProperty::Representation + + property :mcm_id, as: 'mcmId' + property :name, as: 'name' + end + end + + class ManagedConfigurationsSettingsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :managed_configurations_settings, as: 'managedConfigurationsSettings', class: Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettings, decorator: Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettings::Representation + + end + end + class ManagedProperty # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1016,6 +1072,15 @@ module Google end end + + class VariableSet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :placeholder, as: 'placeholder' + property :user_value, as: 'userValue' + end + end end end end diff --git a/generated/google/apis/androidenterprise_v1/service.rb b/generated/google/apis/androidenterprise_v1/service.rb index caf1e241a..9a1e1f148 100644 --- a/generated/google/apis/androidenterprise_v1/service.rb +++ b/generated/google/apis/androidenterprise_v1/service.rb @@ -1848,8 +1848,12 @@ module Google execute_or_queue_command(command, &block) end - # Adds or updates a per-user managed configuration for an app for the specified - # user. This method supports patch semantics. + # Adds or updates the managed configuration settings for an app for the + # specified user. If you support the Managed configurations iframe, you can + # apply managed configurations to a user by specifying an mcmId and its + # associated configuration variables (if any) in the request. Alternatively, all + # EMMs can apply managed configurations by passing a list of managed properties. + # This method supports patch semantics. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -1894,8 +1898,11 @@ module Google execute_or_queue_command(command, &block) end - # Adds or updates a per-user managed configuration for an app for the specified - # user. + # Adds or updates the managed configuration settings for an app for the + # specified user. If you support the Managed configurations iframe, you can + # apply managed configurations to a user by specifying an mcmId and its + # associated configuration variables (if any) in the request. Alternatively, all + # EMMs can apply managed configurations by passing a list of managed properties. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -1940,6 +1947,45 @@ module Google execute_or_queue_command(command, &block) end + # Lists all the managed configurations settings for the specified app. Only the + # ID and the name is set. + # @param [String] enterprise_id + # The ID of the enterprise. + # @param [String] product_id + # The ID of the product for which the managed configurations settings applies to. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettingsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettingsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_managedconfigurationssettings(enterprise_id, product_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'enterprises/{enterpriseId}/products/{productId}/managedConfigurationsSettings', options) + command.response_representation = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettingsListResponse::Representation + command.response_class = Google::Apis::AndroidenterpriseV1::ManagedConfigurationsSettingsListResponse + command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? + command.params['productId'] = product_id unless product_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Retrieves details of an Android app permission for display to an enterprise # admin. # @param [String] permission_id @@ -3210,6 +3256,45 @@ module Google execute_or_queue_command(command, &block) end + # Revokes access to all devices currently provisioned to the user. The user will + # no longer be able to use the managed Play store on any of their managed + # devices. + # This call only works with EMM-managed accounts. + # @param [String] enterprise_id + # The ID of the enterprise. + # @param [String] user_id + # The ID of the user. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def revoke_user_device_access(enterprise_id, user_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'enterprises/{enterpriseId}/users/{userId}/deviceAccess', options) + command.params['enterpriseId'] = enterprise_id unless enterprise_id.nil? + command.params['userId'] = user_id unless user_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Revokes a previously generated token (activation code) for the user. # @param [String] enterprise_id # The ID of the enterprise. diff --git a/generated/google/apis/androidmanagement_v1.rb b/generated/google/apis/androidmanagement_v1.rb index d37c8d73c..ce6a15848 100644 --- a/generated/google/apis/androidmanagement_v1.rb +++ b/generated/google/apis/androidmanagement_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/android/management module AndroidmanagementV1 VERSION = 'V1' - REVISION = '20170918' + REVISION = '20171030' # Manage Android devices and apps for your customers AUTH_ANDROIDMANAGEMENT = 'https://www.googleapis.com/auth/androidmanagement' diff --git a/generated/google/apis/androidmanagement_v1/classes.rb b/generated/google/apis/androidmanagement_v1/classes.rb index 9c499c8f3..819309835 100644 --- a/generated/google/apis/androidmanagement_v1/classes.rb +++ b/generated/google/apis/androidmanagement_v1/classes.rb @@ -388,11 +388,11 @@ module Google alias_method :policy_compliant?, :policy_compliant # The name of the policy that is intended to be applied to the device. If empty, - # the policy with id default is applied. This field may be modified by an update - # request. The name of the policy is in the form enterprises/`enterpriseId`/ - # policies/`policyId`. It is also permissible to only specify the policyId when - # updating this field as long as the policyId contains no slashes since the rest - # of the policy name can be inferred from context. + # the policy_name for the user that owns this device is applied. This field may + # be modified by an update request. The name of the policy is in the form + # enterprises/`enterpriseId`/policies/`policyId`. It is also permissible to only + # specify the policyId when updating this field as long as the policyId contains + # no slashes since the rest of the policy name can be inferred from context. # Corresponds to the JSON property `policyName` # @return [String] attr_accessor :policy_name @@ -425,9 +425,8 @@ module Google # @return [String] attr_accessor :state - # The resource name of the user of the device in the form enterprises/` - # enterpriseId`/users/`userId`. This is the name of the device account - # automatically created for this device. + # The resource name of the user that owns this device in the form enterprises/` + # enterpriseId`/users/`userId`. # Corresponds to the JSON property `userName` # @return [String] attr_accessor :user_name @@ -575,9 +574,11 @@ module Google # The name of the policy that will be initially applied to the enrolled device # in the form enterprises/`enterpriseId`/policies/`policyId`. If not specified, - # the policy with id default is applied. It is permissible to only specify the - # policyId when updating this field as long as the policyId contains no slashes - # since the rest of the policy name can be inferred from context. + # the policy_name for the user that owns the device is applied. If user_name + # also isn't specified, the policy defaults to enterprises/`enterpriseId`/ + # policies/default. It is permissible to only specify the policyId when updating + # this field as long as the policyId contains no slashes since the rest of the + # policy name can be inferred from context. # Corresponds to the JSON property `policyName` # @return [String] attr_accessor :policy_name diff --git a/generated/google/apis/androidpublisher_v2.rb b/generated/google/apis/androidpublisher_v2.rb index 77c6f7945..d730a5b60 100644 --- a/generated/google/apis/androidpublisher_v2.rb +++ b/generated/google/apis/androidpublisher_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android-publisher module AndroidpublisherV2 VERSION = 'V2' - REVISION = '20170913' + REVISION = '20171030' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/androidpublisher_v2/classes.rb b/generated/google/apis/androidpublisher_v2/classes.rb index 2fcca7fc0..d63be3c85 100644 --- a/generated/google/apis/androidpublisher_v2/classes.rb +++ b/generated/google/apis/androidpublisher_v2/classes.rb @@ -876,157 +876,6 @@ module Google end end - # - class InAppProductsBatchRequest - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `entrys` - # @return [Array] - attr_accessor :entrys - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @entrys = args[:entrys] if args.key?(:entrys) - end - end - - # - class InAppProductsBatchRequestEntry - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `batchId` - # @return [Fixnum] - attr_accessor :batch_id - - # - # Corresponds to the JSON property `inappproductsinsertrequest` - # @return [Google::Apis::AndroidpublisherV2::InsertInAppProductsRequest] - attr_accessor :inappproductsinsertrequest - - # - # Corresponds to the JSON property `inappproductsupdaterequest` - # @return [Google::Apis::AndroidpublisherV2::UpdateInAppProductsRequest] - attr_accessor :inappproductsupdaterequest - - # - # Corresponds to the JSON property `methodName` - # @return [String] - attr_accessor :method_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @batch_id = args[:batch_id] if args.key?(:batch_id) - @inappproductsinsertrequest = args[:inappproductsinsertrequest] if args.key?(:inappproductsinsertrequest) - @inappproductsupdaterequest = args[:inappproductsupdaterequest] if args.key?(:inappproductsupdaterequest) - @method_name = args[:method_name] if args.key?(:method_name) - end - end - - # - class InAppProductsBatchResponse - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `entrys` - # @return [Array] - attr_accessor :entrys - - # Identifies what kind of resource this is. Value: the fixed string " - # androidpublisher#inappproductsBatchResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @entrys = args[:entrys] if args.key?(:entrys) - @kind = args[:kind] if args.key?(:kind) - end - end - - # - class InAppProductsBatchResponseEntry - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `batchId` - # @return [Fixnum] - attr_accessor :batch_id - - # - # Corresponds to the JSON property `inappproductsinsertresponse` - # @return [Google::Apis::AndroidpublisherV2::InsertInAppProductsResponse] - attr_accessor :inappproductsinsertresponse - - # - # Corresponds to the JSON property `inappproductsupdateresponse` - # @return [Google::Apis::AndroidpublisherV2::UpdateInAppProductsResponse] - attr_accessor :inappproductsupdateresponse - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @batch_id = args[:batch_id] if args.key?(:batch_id) - @inappproductsinsertresponse = args[:inappproductsinsertresponse] if args.key?(:inappproductsinsertresponse) - @inappproductsupdateresponse = args[:inappproductsupdateresponse] if args.key?(:inappproductsupdateresponse) - end - end - - # - class InsertInAppProductsRequest - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `inappproduct` - # @return [Google::Apis::AndroidpublisherV2::InAppProduct] - attr_accessor :inappproduct - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @inappproduct = args[:inappproduct] if args.key?(:inappproduct) - end - end - - # - class InsertInAppProductsResponse - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `inappproduct` - # @return [Google::Apis::AndroidpublisherV2::InAppProduct] - attr_accessor :inappproduct - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @inappproduct = args[:inappproduct] if args.key?(:inappproduct) - end - end - # class ListInAppProductsResponse include Google::Apis::Core::Hashable @@ -1065,44 +914,6 @@ module Google end end - # - class UpdateInAppProductsRequest - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `inappproduct` - # @return [Google::Apis::AndroidpublisherV2::InAppProduct] - attr_accessor :inappproduct - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @inappproduct = args[:inappproduct] if args.key?(:inappproduct) - end - end - - # - class UpdateInAppProductsResponse - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `inappproduct` - # @return [Google::Apis::AndroidpublisherV2::InAppProduct] - attr_accessor :inappproduct - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @inappproduct = args[:inappproduct] if args.key?(:inappproduct) - end - end - # class Listing include Google::Apis::Core::Hashable diff --git a/generated/google/apis/androidpublisher_v2/representations.rb b/generated/google/apis/androidpublisher_v2/representations.rb index 137fc63b4..104470116 100644 --- a/generated/google/apis/androidpublisher_v2/representations.rb +++ b/generated/google/apis/androidpublisher_v2/representations.rb @@ -178,60 +178,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class InAppProductsBatchRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InAppProductsBatchRequestEntry - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InAppProductsBatchResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InAppProductsBatchResponseEntry - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InsertInAppProductsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InsertInAppProductsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class ListInAppProductsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class UpdateInAppProductsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UpdateInAppProductsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class Listing class Representation < Google::Apis::Core::JsonRepresentation; end @@ -640,62 +592,6 @@ module Google end end - class InAppProductsBatchRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :entrys, as: 'entrys', class: Google::Apis::AndroidpublisherV2::InAppProductsBatchRequestEntry, decorator: Google::Apis::AndroidpublisherV2::InAppProductsBatchRequestEntry::Representation - - end - end - - class InAppProductsBatchRequestEntry - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :batch_id, as: 'batchId' - property :inappproductsinsertrequest, as: 'inappproductsinsertrequest', class: Google::Apis::AndroidpublisherV2::InsertInAppProductsRequest, decorator: Google::Apis::AndroidpublisherV2::InsertInAppProductsRequest::Representation - - property :inappproductsupdaterequest, as: 'inappproductsupdaterequest', class: Google::Apis::AndroidpublisherV2::UpdateInAppProductsRequest, decorator: Google::Apis::AndroidpublisherV2::UpdateInAppProductsRequest::Representation - - property :method_name, as: 'methodName' - end - end - - class InAppProductsBatchResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :entrys, as: 'entrys', class: Google::Apis::AndroidpublisherV2::InAppProductsBatchResponseEntry, decorator: Google::Apis::AndroidpublisherV2::InAppProductsBatchResponseEntry::Representation - - property :kind, as: 'kind' - end - end - - class InAppProductsBatchResponseEntry - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :batch_id, as: 'batchId' - property :inappproductsinsertresponse, as: 'inappproductsinsertresponse', class: Google::Apis::AndroidpublisherV2::InsertInAppProductsResponse, decorator: Google::Apis::AndroidpublisherV2::InsertInAppProductsResponse::Representation - - property :inappproductsupdateresponse, as: 'inappproductsupdateresponse', class: Google::Apis::AndroidpublisherV2::UpdateInAppProductsResponse, decorator: Google::Apis::AndroidpublisherV2::UpdateInAppProductsResponse::Representation - - end - end - - class InsertInAppProductsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :inappproduct, as: 'inappproduct', class: Google::Apis::AndroidpublisherV2::InAppProduct, decorator: Google::Apis::AndroidpublisherV2::InAppProduct::Representation - - end - end - - class InsertInAppProductsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :inappproduct, as: 'inappproduct', class: Google::Apis::AndroidpublisherV2::InAppProduct, decorator: Google::Apis::AndroidpublisherV2::InAppProduct::Representation - - end - end - class ListInAppProductsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -709,22 +605,6 @@ module Google end end - class UpdateInAppProductsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :inappproduct, as: 'inappproduct', class: Google::Apis::AndroidpublisherV2::InAppProduct, decorator: Google::Apis::AndroidpublisherV2::InAppProduct::Representation - - end - end - - class UpdateInAppProductsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :inappproduct, as: 'inappproduct', class: Google::Apis::AndroidpublisherV2::InAppProduct, decorator: Google::Apis::AndroidpublisherV2::InAppProduct::Representation - - end - end - class Listing # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/androidpublisher_v2/service.rb b/generated/google/apis/androidpublisher_v2/service.rb index 71306d19f..c02ddc373 100644 --- a/generated/google/apis/androidpublisher_v2/service.rb +++ b/generated/google/apis/androidpublisher_v2/service.rb @@ -1839,41 +1839,6 @@ module Google execute_or_queue_command(command, &block) end - # - # @param [Google::Apis::AndroidpublisherV2::InAppProductsBatchRequest] in_app_products_batch_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # Overrides userIp if both are provided. - # @param [String] user_ip - # IP address of the site where the request originates. Use this if you want to - # enforce per-user limits. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::AndroidpublisherV2::InAppProductsBatchResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::AndroidpublisherV2::InAppProductsBatchResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def batch_update_in_app_products(in_app_products_batch_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'inappproducts/batch', options) - command.request_representation = Google::Apis::AndroidpublisherV2::InAppProductsBatchRequest::Representation - command.request_object = in_app_products_batch_request_object - command.response_representation = Google::Apis::AndroidpublisherV2::InAppProductsBatchResponse::Representation - command.response_class = Google::Apis::AndroidpublisherV2::InAppProductsBatchResponse - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - # Delete an in-app product for an app. # @param [String] package_name # Unique identifier for the Android app with the in-app product; for example, " diff --git a/generated/google/apis/appengine_v1.rb b/generated/google/apis/appengine_v1.rb index 35fbf02b7..c7d2d5e72 100644 --- a/generated/google/apis/appengine_v1.rb +++ b/generated/google/apis/appengine_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1 VERSION = 'V1' - REVISION = '20170926' + REVISION = '20171109' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1/classes.rb b/generated/google/apis/appengine_v1/classes.rb index 8c0b9f748..94046586d 100644 --- a/generated/google/apis/appengine_v1/classes.rb +++ b/generated/google/apis/appengine_v1/classes.rb @@ -87,7 +87,7 @@ module Google end # An Application resource contains the top-level configuration of an App Engine - # application. Next tag: 20 + # application. class Application include Google::Apis::Core::Hashable @@ -370,6 +370,11 @@ module Google # @return [Google::Apis::AppengineV1::RequestUtilization] attr_accessor :request_utilization + # Scheduler settings for standard environment. + # Corresponds to the JSON property `standardSchedulerSettings` + # @return [Google::Apis::AppengineV1::StandardSchedulerSettings] + attr_accessor :standard_scheduler_settings + def initialize(**args) update!(**args) end @@ -388,6 +393,7 @@ module Google @min_total_instances = args[:min_total_instances] if args.key?(:min_total_instances) @network_utilization = args[:network_utilization] if args.key?(:network_utilization) @request_utilization = args[:request_utilization] if args.key?(:request_utilization) + @standard_scheduler_settings = args[:standard_scheduler_settings] if args.key?(:standard_scheduler_settings) end end @@ -1713,51 +1719,6 @@ module Google end end - # Metadata for the given google.longrunning.Operation. - class OperationMetadataExperimental - include Google::Apis::Core::Hashable - - # Time that this operation completed.@OutputOnly - # Corresponds to the JSON property `endTime` - # @return [String] - attr_accessor :end_time - - # Time that this operation was created.@OutputOnly - # Corresponds to the JSON property `insertTime` - # @return [String] - attr_accessor :insert_time - - # API method that initiated this operation. Example: google.appengine. - # experimental.CustomDomains.CreateCustomDomain.@OutputOnly - # Corresponds to the JSON property `method` - # @return [String] - attr_accessor :method_prop - - # Name of the resource that this operation is acting on. Example: apps/myapp/ - # customDomains/example.com.@OutputOnly - # Corresponds to the JSON property `target` - # @return [String] - attr_accessor :target - - # User who requested this operation.@OutputOnly - # Corresponds to the JSON property `user` - # @return [String] - attr_accessor :user - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @end_time = args[:end_time] if args.key?(:end_time) - @insert_time = args[:insert_time] if args.key?(:insert_time) - @method_prop = args[:method_prop] if args.key?(:method_prop) - @target = args[:target] if args.key?(:target) - @user = args[:user] if args.key?(:user) - end - end - # Metadata for the given google.longrunning.Operation. class OperationMetadataV1 include Google::Apis::Core::Hashable @@ -2222,6 +2183,45 @@ module Google end end + # Scheduler settings for standard environment. + class StandardSchedulerSettings + include Google::Apis::Core::Hashable + + # Maximum number of instances for an app version. Set to a non-positive value (0 + # by convention) to disable max_instances configuration. + # Corresponds to the JSON property `maxInstances` + # @return [Fixnum] + attr_accessor :max_instances + + # Minimum number of instances for an app version. Set to a non-positive value (0 + # by convention) to disable min_instances configuration. + # Corresponds to the JSON property `minInstances` + # @return [Fixnum] + attr_accessor :min_instances + + # Target CPU utilization ratio to maintain when scaling. + # Corresponds to the JSON property `targetCpuUtilization` + # @return [Float] + attr_accessor :target_cpu_utilization + + # Target throughput utilization ratio to maintain when scaling + # Corresponds to the JSON property `targetThroughputUtilization` + # @return [Float] + attr_accessor :target_throughput_utilization + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @max_instances = args[:max_instances] if args.key?(:max_instances) + @min_instances = args[:min_instances] if args.key?(:min_instances) + @target_cpu_utilization = args[:target_cpu_utilization] if args.key?(:target_cpu_utilization) + @target_throughput_utilization = args[:target_throughput_utilization] if args.key?(:target_throughput_utilization) + end + end + # Files served directly to the user for a given URL, such as images, CSS # stylesheets, or JavaScript source files. Static file handlers describe which # files in the application directory are static files, and which URLs serve them. diff --git a/generated/google/apis/appengine_v1/representations.rb b/generated/google/apis/appengine_v1/representations.rb index 182442e05..37ed06427 100644 --- a/generated/google/apis/appengine_v1/representations.rb +++ b/generated/google/apis/appengine_v1/representations.rb @@ -280,12 +280,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class OperationMetadataExperimental - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class OperationMetadataV1 class Representation < Google::Apis::Core::JsonRepresentation; end @@ -358,6 +352,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class StandardSchedulerSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class StaticFilesHandler class Representation < Google::Apis::Core::JsonRepresentation; end @@ -488,6 +488,8 @@ module Google property :request_utilization, as: 'requestUtilization', class: Google::Apis::AppengineV1::RequestUtilization, decorator: Google::Apis::AppengineV1::RequestUtilization::Representation + property :standard_scheduler_settings, as: 'standardSchedulerSettings', class: Google::Apis::AppengineV1::StandardSchedulerSettings, decorator: Google::Apis::AppengineV1::StandardSchedulerSettings::Representation + end end @@ -844,17 +846,6 @@ module Google end end - class OperationMetadataExperimental - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :end_time, as: 'endTime' - property :insert_time, as: 'insertTime' - property :method_prop, as: 'method' - property :target, as: 'target' - property :user, as: 'user' - end - end - class OperationMetadataV1 # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -976,6 +967,16 @@ module Google end end + class StandardSchedulerSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :max_instances, as: 'maxInstances' + property :min_instances, as: 'minInstances' + property :target_cpu_utilization, as: 'targetCpuUtilization' + property :target_throughput_utilization, as: 'targetThroughputUtilization' + end + end + class StaticFilesHandler # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/appengine_v1/service.rb b/generated/google/apis/appengine_v1/service.rb index 4534efdd7..18ecc7fc4 100644 --- a/generated/google/apis/appengine_v1/service.rb +++ b/generated/google/apis/appengine_v1/service.rb @@ -420,6 +420,9 @@ module Google # @param [String] apps_id # Part of `parent`. Name of the parent Application resource. Example: apps/myapp. # @param [Google::Apis::AppengineV1::DomainMapping] domain_mapping_object + # @param [String] override_strategy + # Whether the domain creation should override any existing mappings for this + # domain. By default, overrides are rejected. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -437,13 +440,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_app_domain_mapping(apps_id, domain_mapping_object = nil, fields: nil, quota_user: nil, options: nil, &block) + def create_app_domain_mapping(apps_id, domain_mapping_object = nil, override_strategy: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/apps/{appsId}/domainMappings', options) command.request_representation = Google::Apis::AppengineV1::DomainMapping::Representation command.request_object = domain_mapping_object command.response_representation = Google::Apis::AppengineV1::Operation::Representation command.response_class = Google::Apis::AppengineV1::Operation command.params['appsId'] = apps_id unless apps_id.nil? + command.query['overrideStrategy'] = override_strategy unless override_strategy.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) diff --git a/generated/google/apis/appengine_v1alpha.rb b/generated/google/apis/appengine_v1alpha.rb index d0d0e0676..27c36a494 100644 --- a/generated/google/apis/appengine_v1alpha.rb +++ b/generated/google/apis/appengine_v1alpha.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1alpha VERSION = 'V1alpha' - REVISION = '20170714' + REVISION = '20171026' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1alpha/classes.rb b/generated/google/apis/appengine_v1alpha/classes.rb index 702a842d2..1e64cb49a 100644 --- a/generated/google/apis/appengine_v1alpha/classes.rb +++ b/generated/google/apis/appengine_v1alpha/classes.rb @@ -586,51 +586,6 @@ module Google end end - # Metadata for the given google.longrunning.Operation. - class OperationMetadataExperimental - include Google::Apis::Core::Hashable - - # Time that this operation completed.@OutputOnly - # Corresponds to the JSON property `endTime` - # @return [String] - attr_accessor :end_time - - # Time that this operation was created.@OutputOnly - # Corresponds to the JSON property `insertTime` - # @return [String] - attr_accessor :insert_time - - # API method that initiated this operation. Example: google.appengine. - # experimental.CustomDomains.CreateCustomDomain.@OutputOnly - # Corresponds to the JSON property `method` - # @return [String] - attr_accessor :method_prop - - # Name of the resource that this operation is acting on. Example: apps/myapp/ - # customDomains/example.com.@OutputOnly - # Corresponds to the JSON property `target` - # @return [String] - attr_accessor :target - - # User who requested this operation.@OutputOnly - # Corresponds to the JSON property `user` - # @return [String] - attr_accessor :user - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @end_time = args[:end_time] if args.key?(:end_time) - @insert_time = args[:insert_time] if args.key?(:insert_time) - @method_prop = args[:method_prop] if args.key?(:method_prop) - @target = args[:target] if args.key?(:target) - @user = args[:user] if args.key?(:user) - end - end - # Metadata for the given google.longrunning.Operation. class OperationMetadataV1 include Google::Apis::Core::Hashable diff --git a/generated/google/apis/appengine_v1alpha/representations.rb b/generated/google/apis/appengine_v1alpha/representations.rb index 104fb6d8b..a0dfbecd8 100644 --- a/generated/google/apis/appengine_v1alpha/representations.rb +++ b/generated/google/apis/appengine_v1alpha/representations.rb @@ -112,12 +112,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class OperationMetadataExperimental - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class OperationMetadataV1 class Representation < Google::Apis::Core::JsonRepresentation; end @@ -306,17 +300,6 @@ module Google end end - class OperationMetadataExperimental - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :end_time, as: 'endTime' - property :insert_time, as: 'insertTime' - property :method_prop, as: 'method' - property :target, as: 'target' - property :user, as: 'user' - end - end - class OperationMetadataV1 # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/appengine_v1alpha/service.rb b/generated/google/apis/appengine_v1alpha/service.rb index e06e98731..4d8d8a16a 100644 --- a/generated/google/apis/appengine_v1alpha/service.rb +++ b/generated/google/apis/appengine_v1alpha/service.rb @@ -282,6 +282,9 @@ module Google # certificate ID must be manaually set in the DomainMapping resource to # configure SSL for this domain. If false, a managed certificate will be # provisioned and a certificate ID will be automatically populated. + # @param [String] override_strategy + # Whether the domain creation should override any existing mappings for this + # domain. By default, overrides are rejected. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -299,7 +302,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_app_domain_mapping(apps_id, domain_mapping_object = nil, no_managed_certificate: nil, fields: nil, quota_user: nil, options: nil, &block) + def create_app_domain_mapping(apps_id, domain_mapping_object = nil, no_managed_certificate: nil, override_strategy: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha/apps/{appsId}/domainMappings', options) command.request_representation = Google::Apis::AppengineV1alpha::DomainMapping::Representation command.request_object = domain_mapping_object @@ -307,6 +310,7 @@ module Google command.response_class = Google::Apis::AppengineV1alpha::Operation command.params['appsId'] = apps_id unless apps_id.nil? command.query['noManagedCertificate'] = no_managed_certificate unless no_managed_certificate.nil? + command.query['overrideStrategy'] = override_strategy unless override_strategy.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) diff --git a/generated/google/apis/appengine_v1beta.rb b/generated/google/apis/appengine_v1beta.rb index 019760ea2..f4e0d5b85 100644 --- a/generated/google/apis/appengine_v1beta.rb +++ b/generated/google/apis/appengine_v1beta.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta VERSION = 'V1beta' - REVISION = '20170901' + REVISION = '20171109' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1beta/classes.rb b/generated/google/apis/appengine_v1beta/classes.rb index a6d3d2d1d..cc03c3faf 100644 --- a/generated/google/apis/appengine_v1beta/classes.rb +++ b/generated/google/apis/appengine_v1beta/classes.rb @@ -87,7 +87,7 @@ module Google end # An Application resource contains the top-level configuration of an App Engine - # application. Next tag: 20 + # application. class Application include Google::Apis::Core::Hashable @@ -737,7 +737,10 @@ module Google include Google::Apis::Core::Hashable # Endpoints service configuration id as specified by the Service Management API. - # For example "2016-09-19r1" + # For example "2016-09-19r1"By default, the Endpoints service configuration id + # is fixed and config_id must be specified. To keep the Endpoints service + # configuration id updated with each rollout, specify RolloutStrategy.MANAGED + # and omit config_id. # Corresponds to the JSON property `configId` # @return [String] attr_accessor :config_id @@ -805,6 +808,13 @@ module Google attr_accessor :split_health_checks alias_method :split_health_checks?, :split_health_checks + # If true, use Container-Optimized OS (https://cloud.google.com/container- + # optimized-os/) base image for VMs, rather than a base Debian image. + # Corresponds to the JSON property `useContainerOptimizedOs` + # @return [Boolean] + attr_accessor :use_container_optimized_os + alias_method :use_container_optimized_os?, :use_container_optimized_os + def initialize(**args) update!(**args) end @@ -812,6 +822,7 @@ module Google # Update properties of this object def update!(**args) @split_health_checks = args[:split_health_checks] if args.key?(:split_health_checks) + @use_container_optimized_os = args[:use_container_optimized_os] if args.key?(:use_container_optimized_os) end end @@ -1779,51 +1790,6 @@ module Google end end - # Metadata for the given google.longrunning.Operation. - class OperationMetadataExperimental - include Google::Apis::Core::Hashable - - # Time that this operation completed.@OutputOnly - # Corresponds to the JSON property `endTime` - # @return [String] - attr_accessor :end_time - - # Time that this operation was created.@OutputOnly - # Corresponds to the JSON property `insertTime` - # @return [String] - attr_accessor :insert_time - - # API method that initiated this operation. Example: google.appengine. - # experimental.CustomDomains.CreateCustomDomain.@OutputOnly - # Corresponds to the JSON property `method` - # @return [String] - attr_accessor :method_prop - - # Name of the resource that this operation is acting on. Example: apps/myapp/ - # customDomains/example.com.@OutputOnly - # Corresponds to the JSON property `target` - # @return [String] - attr_accessor :target - - # User who requested this operation.@OutputOnly - # Corresponds to the JSON property `user` - # @return [String] - attr_accessor :user - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @end_time = args[:end_time] if args.key?(:end_time) - @insert_time = args[:insert_time] if args.key?(:insert_time) - @method_prop = args[:method_prop] if args.key?(:method_prop) - @target = args[:target] if args.key?(:target) - @user = args[:user] if args.key?(:user) - end - end - # Metadata for the given google.longrunning.Operation. class OperationMetadataV1 include Google::Apis::Core::Hashable diff --git a/generated/google/apis/appengine_v1beta/representations.rb b/generated/google/apis/appengine_v1beta/representations.rb index 7ae9493d9..ea8bd17df 100644 --- a/generated/google/apis/appengine_v1beta/representations.rb +++ b/generated/google/apis/appengine_v1beta/representations.rb @@ -292,12 +292,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class OperationMetadataExperimental - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class OperationMetadataV1 class Representation < Google::Apis::Core::JsonRepresentation; end @@ -637,6 +631,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :split_health_checks, as: 'splitHealthChecks' + property :use_container_optimized_os, as: 'useContainerOptimizedOs' end end @@ -883,17 +878,6 @@ module Google end end - class OperationMetadataExperimental - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :end_time, as: 'endTime' - property :insert_time, as: 'insertTime' - property :method_prop, as: 'method' - property :target, as: 'target' - property :user, as: 'user' - end - end - class OperationMetadataV1 # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/appengine_v1beta/service.rb b/generated/google/apis/appengine_v1beta/service.rb index 9526f591e..2a7fc2136 100644 --- a/generated/google/apis/appengine_v1beta/service.rb +++ b/generated/google/apis/appengine_v1beta/service.rb @@ -420,6 +420,9 @@ module Google # @param [String] apps_id # Part of `parent`. Name of the parent Application resource. Example: apps/myapp. # @param [Google::Apis::AppengineV1beta::DomainMapping] domain_mapping_object + # @param [String] override_strategy + # Whether the domain creation should override any existing mappings for this + # domain. By default, overrides are rejected. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -437,13 +440,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_app_domain_mapping(apps_id, domain_mapping_object = nil, fields: nil, quota_user: nil, options: nil, &block) + def create_app_domain_mapping(apps_id, domain_mapping_object = nil, override_strategy: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta/apps/{appsId}/domainMappings', options) command.request_representation = Google::Apis::AppengineV1beta::DomainMapping::Representation command.request_object = domain_mapping_object command.response_representation = Google::Apis::AppengineV1beta::Operation::Representation command.response_class = Google::Apis::AppengineV1beta::Operation command.params['appsId'] = apps_id unless apps_id.nil? + command.query['overrideStrategy'] = override_strategy unless override_strategy.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) diff --git a/generated/google/apis/appengine_v1beta4.rb b/generated/google/apis/appengine_v1beta4.rb index b39acbe94..0a4ba25d5 100644 --- a/generated/google/apis/appengine_v1beta4.rb +++ b/generated/google/apis/appengine_v1beta4.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta4 VERSION = 'V1beta4' - REVISION = '20170714' + REVISION = '20171026' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1beta4/classes.rb b/generated/google/apis/appengine_v1beta4/classes.rb index 703eb4364..cb7363ead 100644 --- a/generated/google/apis/appengine_v1beta4/classes.rb +++ b/generated/google/apis/appengine_v1beta4/classes.rb @@ -437,6 +437,40 @@ module Google end end + # Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The + # Endpoints API Service provides tooling for serving Open API and gRPC endpoints + # via an NGINX proxy.The fields here refer to the name and configuration id of a + # "service" resource in the Service Management API (https://cloud.google.com/ + # service-management/overview). + class EndpointsApiService + include Google::Apis::Core::Hashable + + # Endpoints service configuration id as specified by the Service Management API. + # For example "2016-09-19r1"By default, the Endpoints service configuration id + # is fixed and config_id must be specified. To keep the Endpoints service + # configuration id updated with each rollout, specify RolloutStrategy.MANAGED + # and omit config_id. + # Corresponds to the JSON property `configId` + # @return [String] + attr_accessor :config_id + + # Endpoints service name which is the name of the "service" resource in the + # Service Management API. For example "myapi.endpoints.myproject.cloud.goog" + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @config_id = args[:config_id] if args.key?(:config_id) + @name = args[:name] if args.key?(:name) + end + end + # Custom static error page to be served when an error occurs. class ErrorHandler include Google::Apis::Core::Hashable @@ -1213,51 +1247,6 @@ module Google end end - # Metadata for the given google.longrunning.Operation. - class OperationMetadataExperimental - include Google::Apis::Core::Hashable - - # Time that this operation completed.@OutputOnly - # Corresponds to the JSON property `endTime` - # @return [String] - attr_accessor :end_time - - # Time that this operation was created.@OutputOnly - # Corresponds to the JSON property `insertTime` - # @return [String] - attr_accessor :insert_time - - # API method that initiated this operation. Example: google.appengine. - # experimental.CustomDomains.CreateCustomDomain.@OutputOnly - # Corresponds to the JSON property `method` - # @return [String] - attr_accessor :method_prop - - # Name of the resource that this operation is acting on. Example: apps/myapp/ - # customDomains/example.com.@OutputOnly - # Corresponds to the JSON property `target` - # @return [String] - attr_accessor :target - - # User who requested this operation.@OutputOnly - # Corresponds to the JSON property `user` - # @return [String] - attr_accessor :user - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @end_time = args[:end_time] if args.key?(:end_time) - @insert_time = args[:insert_time] if args.key?(:insert_time) - @method_prop = args[:method_prop] if args.key?(:method_prop) - @target = args[:target] if args.key?(:target) - @user = args[:user] if args.key?(:user) - end - end - # Metadata for the given google.longrunning.Operation. class OperationMetadataV1 include Google::Apis::Core::Hashable @@ -1982,6 +1971,15 @@ module Google # @return [Google::Apis::AppengineV1beta4::Deployment] attr_accessor :deployment + # Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The + # Endpoints API Service provides tooling for serving Open API and gRPC endpoints + # via an NGINX proxy.The fields here refer to the name and configuration id of a + # "service" resource in the Service Management API (https://cloud.google.com/ + # service-management/overview). + # Corresponds to the JSON property `endpointsApiService` + # @return [Google::Apis::AppengineV1beta4::EndpointsApiService] + attr_accessor :endpoints_api_service + # App Engine execution environment to use for this version.Defaults to 1. # Corresponds to the JSON property `env` # @return [String] @@ -2113,6 +2111,7 @@ module Google @default_expiration = args[:default_expiration] if args.key?(:default_expiration) @deployer = args[:deployer] if args.key?(:deployer) @deployment = args[:deployment] if args.key?(:deployment) + @endpoints_api_service = args[:endpoints_api_service] if args.key?(:endpoints_api_service) @env = args[:env] if args.key?(:env) @env_variables = args[:env_variables] if args.key?(:env_variables) @error_handlers = args[:error_handlers] if args.key?(:error_handlers) diff --git a/generated/google/apis/appengine_v1beta4/representations.rb b/generated/google/apis/appengine_v1beta4/representations.rb index 88b102ee5..a08286354 100644 --- a/generated/google/apis/appengine_v1beta4/representations.rb +++ b/generated/google/apis/appengine_v1beta4/representations.rb @@ -82,6 +82,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class EndpointsApiService + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ErrorHandler class Representation < Google::Apis::Core::JsonRepresentation; end @@ -196,12 +202,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class OperationMetadataExperimental - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class OperationMetadataV1 class Representation < Google::Apis::Core::JsonRepresentation; end @@ -408,6 +408,14 @@ module Google end end + class EndpointsApiService + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :config_id, as: 'configId' + property :name, as: 'name' + end + end + class ErrorHandler # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -602,17 +610,6 @@ module Google end end - class OperationMetadataExperimental - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :end_time, as: 'endTime' - property :insert_time, as: 'insertTime' - property :method_prop, as: 'method' - property :target, as: 'target' - property :user, as: 'user' - end - end - class OperationMetadataV1 # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -782,6 +779,8 @@ module Google property :deployer, as: 'deployer' property :deployment, as: 'deployment', class: Google::Apis::AppengineV1beta4::Deployment, decorator: Google::Apis::AppengineV1beta4::Deployment::Representation + property :endpoints_api_service, as: 'endpointsApiService', class: Google::Apis::AppengineV1beta4::EndpointsApiService, decorator: Google::Apis::AppengineV1beta4::EndpointsApiService::Representation + property :env, as: 'env' hash :env_variables, as: 'envVariables' collection :error_handlers, as: 'errorHandlers', class: Google::Apis::AppengineV1beta4::ErrorHandler, decorator: Google::Apis::AppengineV1beta4::ErrorHandler::Representation diff --git a/generated/google/apis/appengine_v1beta5.rb b/generated/google/apis/appengine_v1beta5.rb index 6ddd10b99..5e09dfecf 100644 --- a/generated/google/apis/appengine_v1beta5.rb +++ b/generated/google/apis/appengine_v1beta5.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta5 VERSION = 'V1beta5' - REVISION = '20170714' + REVISION = '20171026' # View and manage your applications deployed on Google App Engine AUTH_APPENGINE_ADMIN = 'https://www.googleapis.com/auth/appengine.admin' diff --git a/generated/google/apis/appengine_v1beta5/classes.rb b/generated/google/apis/appengine_v1beta5/classes.rb index 2a58f4d9b..9d4dc1a89 100644 --- a/generated/google/apis/appengine_v1beta5/classes.rb +++ b/generated/google/apis/appengine_v1beta5/classes.rb @@ -446,7 +446,10 @@ module Google include Google::Apis::Core::Hashable # Endpoints service configuration id as specified by the Service Management API. - # For example "2016-09-19r1" + # For example "2016-09-19r1"By default, the Endpoints service configuration id + # is fixed and config_id must be specified. To keep the Endpoints service + # configuration id updated with each rollout, specify RolloutStrategy.MANAGED + # and omit config_id. # Corresponds to the JSON property `configId` # @return [String] attr_accessor :config_id @@ -1224,51 +1227,6 @@ module Google end end - # Metadata for the given google.longrunning.Operation. - class OperationMetadataExperimental - include Google::Apis::Core::Hashable - - # Time that this operation completed.@OutputOnly - # Corresponds to the JSON property `endTime` - # @return [String] - attr_accessor :end_time - - # Time that this operation was created.@OutputOnly - # Corresponds to the JSON property `insertTime` - # @return [String] - attr_accessor :insert_time - - # API method that initiated this operation. Example: google.appengine. - # experimental.CustomDomains.CreateCustomDomain.@OutputOnly - # Corresponds to the JSON property `method` - # @return [String] - attr_accessor :method_prop - - # Name of the resource that this operation is acting on. Example: apps/myapp/ - # customDomains/example.com.@OutputOnly - # Corresponds to the JSON property `target` - # @return [String] - attr_accessor :target - - # User who requested this operation.@OutputOnly - # Corresponds to the JSON property `user` - # @return [String] - attr_accessor :user - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @end_time = args[:end_time] if args.key?(:end_time) - @insert_time = args[:insert_time] if args.key?(:insert_time) - @method_prop = args[:method_prop] if args.key?(:method_prop) - @target = args[:target] if args.key?(:target) - @user = args[:user] if args.key?(:user) - end - end - # Metadata for the given google.longrunning.Operation. class OperationMetadataV1 include Google::Apis::Core::Hashable diff --git a/generated/google/apis/appengine_v1beta5/representations.rb b/generated/google/apis/appengine_v1beta5/representations.rb index 03e408a8f..e23c39cb7 100644 --- a/generated/google/apis/appengine_v1beta5/representations.rb +++ b/generated/google/apis/appengine_v1beta5/representations.rb @@ -196,12 +196,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class OperationMetadataExperimental - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class OperationMetadataV1 class Representation < Google::Apis::Core::JsonRepresentation; end @@ -601,17 +595,6 @@ module Google end end - class OperationMetadataExperimental - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :end_time, as: 'endTime' - property :insert_time, as: 'insertTime' - property :method_prop, as: 'method' - property :target, as: 'target' - property :user, as: 'user' - end - end - class OperationMetadataV1 # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/bigquery_v2.rb b/generated/google/apis/bigquery_v2.rb index 1fc721c90..9ec73adad 100644 --- a/generated/google/apis/bigquery_v2.rb +++ b/generated/google/apis/bigquery_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryV2 VERSION = 'V2' - REVISION = '20170930' + REVISION = '20171027' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigquery_v2/classes.rb b/generated/google/apis/bigquery_v2/classes.rb index 28e72b10c..c66019d45 100644 --- a/generated/google/apis/bigquery_v2/classes.rb +++ b/generated/google/apis/bigquery_v2/classes.rb @@ -1403,15 +1403,15 @@ module Google # @return [String] attr_accessor :schema_inline_format - # [Experimental] Allows the schema of the desitination table to be updated as a - # side effect of the load job if a schema is autodetected or supplied in the job - # configuration. Schema update options are supported in two cases: when - # writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and - # the destination table is a partition of a table, specified by partition - # decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. - # One or more of the following values are specified: ALLOW_FIELD_ADDITION: - # allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow - # relaxing a required field in the original schema to nullable. + # Allows the schema of the destination table to be updated as a side effect of + # the load job if a schema is autodetected or supplied in the job configuration. + # Schema update options are supported in two cases: when writeDisposition is + # WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination + # table is a partition of a table, specified by partition decorators. For normal + # tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the + # following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable + # field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field + # in the original schema to nullable. # Corresponds to the JSON property `schemaUpdateOptions` # @return [Array] attr_accessor :schema_update_options @@ -1442,8 +1442,7 @@ module Google # @return [Array] attr_accessor :source_uris - # [Experimental] If specified, configures time-based partitioning for the - # destination table. + # If specified, configures time-based partitioning for the destination table. # Corresponds to the JSON property `timePartitioning` # @return [Google::Apis::BigqueryV2::TimePartitioning] attr_accessor :time_partitioning @@ -1585,15 +1584,14 @@ module Google # @return [Array] attr_accessor :query_parameters - # [Experimental] Allows the schema of the destination table to be updated as a - # side effect of the query job. Schema update options are supported in two cases: - # when writeDisposition is WRITE_APPEND; when writeDisposition is - # WRITE_TRUNCATE and the destination table is a partition of a table, specified - # by partition decorators. For normal tables, WRITE_TRUNCATE will always - # overwrite the schema. One or more of the following values are specified: - # ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. - # ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema - # to nullable. + # Allows the schema of the destination table to be updated as a side effect of + # the query job. Schema update options are supported in two cases: when + # writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and + # the destination table is a partition of a table, specified by partition + # decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. + # One or more of the following values are specified: ALLOW_FIELD_ADDITION: + # allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow + # relaxing a required field in the original schema to nullable. # Corresponds to the JSON property `schemaUpdateOptions` # @return [Array] attr_accessor :schema_update_options @@ -1606,8 +1604,7 @@ module Google # @return [Hash] attr_accessor :table_definitions - # [Experimental] If specified, configures time-based partitioning for the - # destination table. + # If specified, configures time-based partitioning for the destination table. # Corresponds to the JSON property `timePartitioning` # @return [Google::Apis::BigqueryV2::TimePartitioning] attr_accessor :time_partitioning @@ -1947,6 +1944,24 @@ module Google attr_accessor :cache_hit alias_method :cache_hit?, :cache_hit + # [Output-only, Experimental] The DDL operation performed, possibly dependent on + # the pre-existence of the DDL target. Possible values (new values might be + # added in the future): "CREATE": The query created the DDL target. "SKIP": No- + # op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table + # already exists, or the query is DROP TABLE IF EXISTS while the table does not + # exist. "REPLACE": The query replaced the DDL target. Example case: the query + # is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query + # deleted the DDL target. + # Corresponds to the JSON property `ddlOperationPerformed` + # @return [String] + attr_accessor :ddl_operation_performed + + # [Output-only, Experimental] The DDL target table. Present only for CREATE/DROP + # TABLE/VIEW queries. + # Corresponds to the JSON property `ddlTargetTable` + # @return [Google::Apis::BigqueryV2::TableReference] + attr_accessor :ddl_target_table + # [Output-only] The number of rows affected by a DML statement. Present only for # DML statements INSERT, UPDATE or DELETE. # Corresponds to the JSON property `numDmlAffectedRows` @@ -2004,6 +2019,8 @@ module Google def update!(**args) @billing_tier = args[:billing_tier] if args.key?(:billing_tier) @cache_hit = args[:cache_hit] if args.key?(:cache_hit) + @ddl_operation_performed = args[:ddl_operation_performed] if args.key?(:ddl_operation_performed) + @ddl_target_table = args[:ddl_target_table] if args.key?(:ddl_target_table) @num_dml_affected_rows = args[:num_dml_affected_rows] if args.key?(:num_dml_affected_rows) @query_plan = args[:query_plan] if args.key?(:query_plan) @referenced_tables = args[:referenced_tables] if args.key?(:referenced_tables) @@ -2702,7 +2719,7 @@ module Google # @return [Google::Apis::BigqueryV2::TableReference] attr_accessor :table_reference - # [Experimental] If specified, configures time-based partitioning for this table. + # If specified, configures time-based partitioning for this table. # Corresponds to the JSON property `timePartitioning` # @return [Google::Apis::BigqueryV2::TimePartitioning] attr_accessor :time_partitioning @@ -3079,7 +3096,7 @@ module Google # @return [Google::Apis::BigqueryV2::TableReference] attr_accessor :table_reference - # [Experimental] The time-based partitioning for this table. + # The time-based partitioning for this table. # Corresponds to the JSON property `timePartitioning` # @return [Google::Apis::BigqueryV2::TimePartitioning] attr_accessor :time_partitioning diff --git a/generated/google/apis/bigquery_v2/representations.rb b/generated/google/apis/bigquery_v2/representations.rb index 90f4e0725..38c23eeeb 100644 --- a/generated/google/apis/bigquery_v2/representations.rb +++ b/generated/google/apis/bigquery_v2/representations.rb @@ -799,6 +799,9 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :billing_tier, as: 'billingTier' property :cache_hit, as: 'cacheHit' + property :ddl_operation_performed, as: 'ddlOperationPerformed' + property :ddl_target_table, as: 'ddlTargetTable', class: Google::Apis::BigqueryV2::TableReference, decorator: Google::Apis::BigqueryV2::TableReference::Representation + property :num_dml_affected_rows, :numeric_string => true, as: 'numDmlAffectedRows' collection :query_plan, as: 'queryPlan', class: Google::Apis::BigqueryV2::ExplainQueryStage, decorator: Google::Apis::BigqueryV2::ExplainQueryStage::Representation diff --git a/generated/google/apis/bigquerydatatransfer_v1.rb b/generated/google/apis/bigquerydatatransfer_v1.rb index 27f79182f..9426f7f81 100644 --- a/generated/google/apis/bigquerydatatransfer_v1.rb +++ b/generated/google/apis/bigquerydatatransfer_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigquerydatatransferV1 VERSION = 'V1' - REVISION = '20171002' + REVISION = '20171113' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigquerydatatransfer_v1/classes.rb b/generated/google/apis/bigquerydatatransfer_v1/classes.rb index 514445125..cbfc9d725 100644 --- a/generated/google/apis/bigquerydatatransfer_v1/classes.rb +++ b/generated/google/apis/bigquerydatatransfer_v1/classes.rb @@ -560,6 +560,78 @@ module Google end end + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by + # [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error message, + # and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + class Status + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # A developer-facing error message, which should be in English. Any + # user-facing error message should be localized and sent in the + # google.rpc.Status.details field, or localized by the client. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + # Represents a data transfer configuration. A transfer configuration # contains all metadata needed to perform a data transfer. For example, # `destination_dataset_id` specifies where data should be stored. @@ -714,6 +786,7 @@ module Google end # Represents a data transfer run. + # Next id: 23 class TransferRun include Google::Apis::Core::Hashable @@ -722,11 +795,6 @@ module Google # @return [String] attr_accessor :data_source_id - # Output only. Region in which BigQuery dataset is located. - # Corresponds to the JSON property `datasetRegion` - # @return [String] - attr_accessor :dataset_region - # The BigQuery target dataset id. # Corresponds to the JSON property `destinationDatasetId` # @return [String] @@ -738,6 +806,49 @@ module Google # @return [String] attr_accessor :end_time + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by + # [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error message, + # and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + # Corresponds to the JSON property `errorStatus` + # @return [Google::Apis::BigquerydatatransferV1::Status] + attr_accessor :error_status + # The resource name of the transfer run. # Transfer run names have the form # `projects/`project_id`/locations/`location`/transferConfigs/`config_id`/runs/` @@ -778,7 +889,7 @@ module Google # @return [String] attr_accessor :start_time - # Output only. Data transfer run state. Ignored for input requests. + # Data transfer run state. Ignored for input requests. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -791,6 +902,7 @@ module Google # Output only. Unique ID of the user on whose behalf transfer is done. # Applicable only to data sources that do not support service accounts. # When set to 0, the data source service account credentials are used. + # May be negative. # Corresponds to the JSON property `userId` # @return [Fixnum] attr_accessor :user_id @@ -802,9 +914,9 @@ module Google # Update properties of this object def update!(**args) @data_source_id = args[:data_source_id] if args.key?(:data_source_id) - @dataset_region = args[:dataset_region] if args.key?(:dataset_region) @destination_dataset_id = args[:destination_dataset_id] if args.key?(:destination_dataset_id) @end_time = args[:end_time] if args.key?(:end_time) + @error_status = args[:error_status] if args.key?(:error_status) @name = args[:name] if args.key?(:name) @params = args[:params] if args.key?(:params) @run_time = args[:run_time] if args.key?(:run_time) diff --git a/generated/google/apis/bigquerydatatransfer_v1/representations.rb b/generated/google/apis/bigquerydatatransfer_v1/representations.rb index b9229aefa..e72e9c59e 100644 --- a/generated/google/apis/bigquerydatatransfer_v1/representations.rb +++ b/generated/google/apis/bigquerydatatransfer_v1/representations.rb @@ -100,6 +100,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class TransferConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -255,6 +261,15 @@ module Google end end + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + class TransferConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -287,9 +302,10 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :data_source_id, as: 'dataSourceId' - property :dataset_region, as: 'datasetRegion' property :destination_dataset_id, as: 'destinationDatasetId' property :end_time, as: 'endTime' + property :error_status, as: 'errorStatus', class: Google::Apis::BigquerydatatransferV1::Status, decorator: Google::Apis::BigquerydatatransferV1::Status::Representation + property :name, as: 'name' hash :params, as: 'params' property :run_time, as: 'runTime' diff --git a/generated/google/apis/bigquerydatatransfer_v1/service.rb b/generated/google/apis/bigquerydatatransfer_v1/service.rb index e628b1810..f3a0a9e2a 100644 --- a/generated/google/apis/bigquerydatatransfer_v1/service.rb +++ b/generated/google/apis/bigquerydatatransfer_v1/service.rb @@ -519,7 +519,7 @@ module Google # @param [String] authorization_code # Optional OAuth2 authorization code to use with this transfer configuration. # If it is provided, the transfer configuration will be associated with the - # gaia id of the authorizing user. + # authorizing user. # In order to obtain authorization_code, please make a # request to # https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=< @@ -566,7 +566,7 @@ module Google execute_or_queue_command(command, &block) end - # Creates transfer runs for a time range [range_start_time, range_end_time]. + # Creates transfer runs for a time range [start_time, end_time]. # For each date - or whatever granularity the data source supports - in the # range, one transfer run is created. # Note that runs are created per UTC time in the time range. @@ -934,7 +934,7 @@ module Google # @param [String] authorization_code # Optional OAuth2 authorization code to use with this transfer configuration. # If it is provided, the transfer configuration will be associated with the - # gaia id of the authorizing user. + # authorizing user. # In order to obtain authorization_code, please make a # request to # https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=< @@ -981,7 +981,7 @@ module Google execute_or_queue_command(command, &block) end - # Creates transfer runs for a time range [range_start_time, range_end_time]. + # Creates transfer runs for a time range [start_time, end_time]. # For each date - or whatever granularity the data source supports - in the # range, one transfer run is created. # Note that runs are created per UTC time in the time range. diff --git a/generated/google/apis/calendar_v3.rb b/generated/google/apis/calendar_v3.rb index f70cd2d7b..743df5a1e 100644 --- a/generated/google/apis/calendar_v3.rb +++ b/generated/google/apis/calendar_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/google-apps/calendar/firstapp module CalendarV3 VERSION = 'V3' - REVISION = '20170905' + REVISION = '20171010' # Manage your calendars AUTH_CALENDAR = 'https://www.googleapis.com/auth/calendar' diff --git a/generated/google/apis/calendar_v3/service.rb b/generated/google/apis/calendar_v3/service.rb index b17562f4f..4ce621ab6 100644 --- a/generated/google/apis/calendar_v3/service.rb +++ b/generated/google/apis/calendar_v3/service.rb @@ -137,6 +137,9 @@ module Google # method. If you want to access the primary calendar of the currently logged in # user, use the "primary" keyword. # @param [Google::Apis::CalendarV3::AclRule] acl_rule_object + # @param [Boolean] send_notifications + # Whether to send notifications about the calendar sharing change. Optional. The + # default is True. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -158,13 +161,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_acl(calendar_id, acl_rule_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def insert_acl(calendar_id, acl_rule_object = nil, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'calendars/{calendarId}/acl', options) command.request_representation = Google::Apis::CalendarV3::AclRule::Representation command.request_object = acl_rule_object command.response_representation = Google::Apis::CalendarV3::AclRule::Representation command.response_class = Google::Apis::CalendarV3::AclRule command.params['calendarId'] = calendar_id unless calendar_id.nil? + command.query['sendNotifications'] = send_notifications unless send_notifications.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -240,6 +244,9 @@ module Google # @param [String] rule_id # ACL rule identifier. # @param [Google::Apis::CalendarV3::AclRule] acl_rule_object + # @param [Boolean] send_notifications + # Whether to send notifications about the calendar sharing change. Note that + # there are no notifications on access removal. Optional. The default is True. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -261,7 +268,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_acl(calendar_id, rule_id, acl_rule_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def patch_acl(calendar_id, rule_id, acl_rule_object = nil, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'calendars/{calendarId}/acl/{ruleId}', options) command.request_representation = Google::Apis::CalendarV3::AclRule::Representation command.request_object = acl_rule_object @@ -269,6 +276,7 @@ module Google command.response_class = Google::Apis::CalendarV3::AclRule command.params['calendarId'] = calendar_id unless calendar_id.nil? command.params['ruleId'] = rule_id unless rule_id.nil? + command.query['sendNotifications'] = send_notifications unless send_notifications.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -283,6 +291,9 @@ module Google # @param [String] rule_id # ACL rule identifier. # @param [Google::Apis::CalendarV3::AclRule] acl_rule_object + # @param [Boolean] send_notifications + # Whether to send notifications about the calendar sharing change. Note that + # there are no notifications on access removal. Optional. The default is True. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -304,7 +315,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_acl(calendar_id, rule_id, acl_rule_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def update_acl(calendar_id, rule_id, acl_rule_object = nil, send_notifications: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'calendars/{calendarId}/acl/{ruleId}', options) command.request_representation = Google::Apis::CalendarV3::AclRule::Representation command.request_object = acl_rule_object @@ -312,6 +323,7 @@ module Google command.response_class = Google::Apis::CalendarV3::AclRule command.params['calendarId'] = calendar_id unless calendar_id.nil? command.params['ruleId'] = rule_id unless rule_id.nil? + command.query['sendNotifications'] = send_notifications unless send_notifications.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? diff --git a/generated/google/apis/classroom_v1.rb b/generated/google/apis/classroom_v1.rb index 51a024318..98acbd180 100644 --- a/generated/google/apis/classroom_v1.rb +++ b/generated/google/apis/classroom_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/classroom/ module ClassroomV1 VERSION = 'V1' - REVISION = '20171004' + REVISION = '20171028' # View and manage announcements in Google Classroom AUTH_CLASSROOM_ANNOUNCEMENTS = 'https://www.googleapis.com/auth/classroom.announcements' @@ -66,6 +66,9 @@ module Google # View the profile photos of people in your classes AUTH_CLASSROOM_PROFILE_PHOTOS = 'https://www.googleapis.com/auth/classroom.profile.photos' + # Receive notifications about your Google Classroom data + AUTH_CLASSROOM_PUSH_NOTIFICATIONS = 'https://www.googleapis.com/auth/classroom.push-notifications' + # Manage your Google Classroom class rosters AUTH_CLASSROOM_ROSTERS = 'https://www.googleapis.com/auth/classroom.rosters' diff --git a/generated/google/apis/cloudbuild_v1.rb b/generated/google/apis/cloudbuild_v1.rb index 9008152c3..89845d579 100644 --- a/generated/google/apis/cloudbuild_v1.rb +++ b/generated/google/apis/cloudbuild_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/container-builder/docs/ module CloudbuildV1 VERSION = 'V1' - REVISION = '20170920' + REVISION = '20171128' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudbuild_v1/classes.rb b/generated/google/apis/cloudbuild_v1/classes.rb index fa488043b..f1b35f7f6 100644 --- a/generated/google/apis/cloudbuild_v1/classes.rb +++ b/generated/google/apis/cloudbuild_v1/classes.rb @@ -230,6 +230,27 @@ module Google class BuildOptions include Google::Apis::Core::Hashable + # Requested disk size for the VM that runs the build. Note that this is *NOT* + # "disk free"; some of the space will be used by the operating system and + # build utilities. Also note that this is the minimum disk size that will be + # allocated for the build -- the build may run with a larger disk than + # requested. At present, the maximum disk size is 1000GB; builds that request + # more than the maximum are rejected with an error. + # Corresponds to the JSON property `diskSizeGb` + # @return [Fixnum] + attr_accessor :disk_size_gb + + # LogStreamingOption to define build log streaming behavior to Google Cloud + # Storage. + # Corresponds to the JSON property `logStreamingOption` + # @return [String] + attr_accessor :log_streaming_option + + # GCE VM size to run the build on. + # Corresponds to the JSON property `machineType` + # @return [String] + attr_accessor :machine_type + # Requested verifiability options. # Corresponds to the JSON property `requestedVerifyOption` # @return [String] @@ -251,6 +272,9 @@ module Google # Update properties of this object def update!(**args) + @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) + @log_streaming_option = args[:log_streaming_option] if args.key?(:log_streaming_option) + @machine_type = args[:machine_type] if args.key?(:machine_type) @requested_verify_option = args[:requested_verify_option] if args.key?(:requested_verify_option) @source_provenance_hash = args[:source_provenance_hash] if args.key?(:source_provenance_hash) @substitution_option = args[:substitution_option] if args.key?(:substitution_option) @@ -734,6 +758,11 @@ module Google # @return [String] attr_accessor :commit_sha + # Directory, relative to the source root, in which to run the build. + # Corresponds to the JSON property `dir` + # @return [String] + attr_accessor :dir + # ID of the project that owns the repo. If omitted, the project ID requesting # the build is assumed. # Corresponds to the JSON property `projectId` @@ -758,6 +787,7 @@ module Google def update!(**args) @branch_name = args[:branch_name] if args.key?(:branch_name) @commit_sha = args[:commit_sha] if args.key?(:commit_sha) + @dir = args[:dir] if args.key?(:dir) @project_id = args[:project_id] if args.key?(:project_id) @repo_name = args[:repo_name] if args.key?(:repo_name) @tag_name = args[:tag_name] if args.key?(:tag_name) @@ -789,6 +819,19 @@ module Google end end + # RetryBuildRequest specifies a build to retry. + class RetryBuildRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # Secret pairs a set of secret environment variables containing encrypted # values with the Cloud KMS key to use to decrypt the value. class Secret diff --git a/generated/google/apis/cloudbuild_v1/representations.rb b/generated/google/apis/cloudbuild_v1/representations.rb index 5069650ad..ec0270187 100644 --- a/generated/google/apis/cloudbuild_v1/representations.rb +++ b/generated/google/apis/cloudbuild_v1/representations.rb @@ -124,6 +124,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class RetryBuildRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Secret class Representation < Google::Apis::Core::JsonRepresentation; end @@ -203,6 +209,9 @@ module Google class BuildOptions # @private class Representation < Google::Apis::Core::JsonRepresentation + property :disk_size_gb, :numeric_string => true, as: 'diskSizeGb' + property :log_streaming_option, as: 'logStreamingOption' + property :machine_type, as: 'machineType' property :requested_verify_option, as: 'requestedVerifyOption' collection :source_provenance_hash, as: 'sourceProvenanceHash' property :substitution_option, as: 'substitutionOption' @@ -326,6 +335,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :branch_name, as: 'branchName' property :commit_sha, as: 'commitSha' + property :dir, as: 'dir' property :project_id, as: 'projectId' property :repo_name, as: 'repoName' property :tag_name, as: 'tagName' @@ -341,6 +351,12 @@ module Google end end + class RetryBuildRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class Secret # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/cloudbuild_v1/service.rb b/generated/google/apis/cloudbuild_v1/service.rb index cd5bc542a..4c5072b83 100644 --- a/generated/google/apis/cloudbuild_v1/service.rb +++ b/generated/google/apis/cloudbuild_v1/service.rb @@ -316,6 +316,61 @@ module Google execute_or_queue_command(command, &block) end + # Creates a new build based on the given build. + # This API creates a new build using the original build request, which may + # or may not result in an identical build. + # For triggered builds: + # * Triggered builds resolve to a precise revision, so a retry of a triggered + # build will result in a build that uses the same revision. + # For non-triggered builds that specify RepoSource: + # * If the original build built from the tip of a branch, the retried build + # will build from the tip of that branch, which may not be the same revision + # as the original build. + # * If the original build specified a commit sha or revision ID, the retried + # build will use the identical source. + # For builds that specify StorageSource: + # * If the original build pulled source from Cloud Storage without specifying + # the generation of the object, the new build will use the current object, + # which may be different from the original build source. + # * If the original build pulled source from Cloud Storage and specified the + # generation of the object, the new build will attempt to use the same + # object, which may or may not be available depending on the bucket's + # lifecycle management settings. + # @param [String] project_id + # ID of the project. + # @param [String] id + # Build ID of the original build. + # @param [Google::Apis::CloudbuildV1::RetryBuildRequest] retry_build_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudbuildV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudbuildV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def retry_build(project_id, id, retry_build_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/projects/{projectId}/builds/{id}:retry', options) + command.request_representation = Google::Apis::CloudbuildV1::RetryBuildRequest::Representation + command.request_object = retry_build_request_object + command.response_representation = Google::Apis::CloudbuildV1::Operation::Representation + command.response_class = Google::Apis::CloudbuildV1::Operation + command.params['projectId'] = project_id unless project_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new BuildTrigger. # This API is experimental. # @param [String] project_id @@ -485,6 +540,42 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end + + # Runs a BuildTrigger at a particular source revision. + # @param [String] project_id + # ID of the project. + # @param [String] trigger_id + # ID of the trigger. + # @param [Google::Apis::CloudbuildV1::RepoSource] repo_source_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudbuildV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudbuildV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def run_project_trigger(project_id, trigger_id, repo_source_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/projects/{projectId}/triggers/{triggerId}:run', options) + command.request_representation = Google::Apis::CloudbuildV1::RepoSource::Representation + command.request_object = repo_source_object + command.response_representation = Google::Apis::CloudbuildV1::Operation::Representation + command.response_class = Google::Apis::CloudbuildV1::Operation + command.params['projectId'] = project_id unless project_id.nil? + command.params['triggerId'] = trigger_id unless trigger_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end protected diff --git a/generated/google/apis/cloudfunctions_v1.rb b/generated/google/apis/cloudfunctions_v1.rb index 0547262f6..f2afd801e 100644 --- a/generated/google/apis/cloudfunctions_v1.rb +++ b/generated/google/apis/cloudfunctions_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/functions module CloudfunctionsV1 VERSION = 'V1' - REVISION = '20170914' + REVISION = '20171101' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudfunctions_v1/classes.rb b/generated/google/apis/cloudfunctions_v1/classes.rb index dcfbabf19..6699597b9 100644 --- a/generated/google/apis/cloudfunctions_v1/classes.rb +++ b/generated/google/apis/cloudfunctions_v1/classes.rb @@ -22,6 +22,392 @@ module Google module Apis module CloudfunctionsV1 + # Request for the `CallFunction` method. + class CallFunctionRequest + include Google::Apis::Core::Hashable + + # Input to be passed to the function. + # Corresponds to the JSON property `data` + # @return [String] + attr_accessor :data + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @data = args[:data] if args.key?(:data) + end + end + + # Response of `CallFunction` method. + class CallFunctionResponse + include Google::Apis::Core::Hashable + + # Either system or user-function generated error. Set if execution + # was not successful. + # Corresponds to the JSON property `error` + # @return [String] + attr_accessor :error + + # Execution id of function invocation. + # Corresponds to the JSON property `executionId` + # @return [String] + attr_accessor :execution_id + + # Result populated for successful execution of synchronous function. Will + # not be populated if function does not return a result through context. + # Corresponds to the JSON property `result` + # @return [String] + attr_accessor :result + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @error = args[:error] if args.key?(:error) + @execution_id = args[:execution_id] if args.key?(:execution_id) + @result = args[:result] if args.key?(:result) + end + end + + # Describes a Cloud Function that contains user computation executed in + # response to an event. It encapsulate function and triggers configurations. + class CloudFunction + include Google::Apis::Core::Hashable + + # The amount of memory in MB available for a function. + # Defaults to 256MB. + # Corresponds to the JSON property `availableMemoryMb` + # @return [Fixnum] + attr_accessor :available_memory_mb + + # User-provided description of a function. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The name of the function (as defined in source code) that will be + # executed. Defaults to the resource name suffix, if not specified. For + # backward compatibility, if function with given name is not found, then the + # system will try to use function named "function". + # For Node.js this is name of a function exported by the module specified + # in `source_location`. + # Corresponds to the JSON property `entryPoint` + # @return [String] + attr_accessor :entry_point + + # Describes EventTrigger, used to request events be sent from another + # service. + # Corresponds to the JSON property `eventTrigger` + # @return [Google::Apis::CloudfunctionsV1::EventTrigger] + attr_accessor :event_trigger + + # Describes HttpsTrigger, could be used to connect web hooks to function. + # Corresponds to the JSON property `httpsTrigger` + # @return [Google::Apis::CloudfunctionsV1::HttpsTrigger] + attr_accessor :https_trigger + + # Labels associated with this Cloud Function. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # A user-defined name of the function. Function names must be unique + # globally and match pattern `projects/*/locations/*/functions/*` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The email of the function's service account. + # Corresponds to the JSON property `serviceAccountEmail` + # @return [String] + attr_accessor :service_account_email + + # The Google Cloud Storage URL, starting with gs://, pointing to the zip + # archive which contains the function. + # Corresponds to the JSON property `sourceArchiveUrl` + # @return [String] + attr_accessor :source_archive_url + + # Describes SourceRepository, used to represent parameters related to + # source repository where a function is hosted. + # Corresponds to the JSON property `sourceRepository` + # @return [Google::Apis::CloudfunctionsV1::SourceRepository] + attr_accessor :source_repository + + # The Google Cloud Storage signed URL used for source uploading, generated + # by google.cloud.functions.v1.GenerateUploadUrl + # Corresponds to the JSON property `sourceUploadUrl` + # @return [String] + attr_accessor :source_upload_url + + # Output only. Status of the function deployment. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # The function execution timeout. Execution is considered failed and + # can be terminated if the function is not completed at the end of the + # timeout period. Defaults to 60 seconds. + # Corresponds to the JSON property `timeout` + # @return [String] + attr_accessor :timeout + + # Output only. The last update timestamp of a Cloud Function. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + # Output only. + # The version identifier of the Cloud Function. Each deployment attempt + # results in a new version of a function being created. + # Corresponds to the JSON property `versionId` + # @return [Fixnum] + attr_accessor :version_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @available_memory_mb = args[:available_memory_mb] if args.key?(:available_memory_mb) + @description = args[:description] if args.key?(:description) + @entry_point = args[:entry_point] if args.key?(:entry_point) + @event_trigger = args[:event_trigger] if args.key?(:event_trigger) + @https_trigger = args[:https_trigger] if args.key?(:https_trigger) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @service_account_email = args[:service_account_email] if args.key?(:service_account_email) + @source_archive_url = args[:source_archive_url] if args.key?(:source_archive_url) + @source_repository = args[:source_repository] if args.key?(:source_repository) + @source_upload_url = args[:source_upload_url] if args.key?(:source_upload_url) + @status = args[:status] if args.key?(:status) + @timeout = args[:timeout] if args.key?(:timeout) + @update_time = args[:update_time] if args.key?(:update_time) + @version_id = args[:version_id] if args.key?(:version_id) + end + end + + # Describes EventTrigger, used to request events be sent from another + # service. + class EventTrigger + include Google::Apis::Core::Hashable + + # Required. The type of event to observe. For example: + # `google.storage.object.finalized` and + # `google.firebase.analytics.event.log`. + # Event type consists of three parts: + # 1. namespace: The domain name of the organization in reverse-domain + # notation (e.g. `acme.net` appears as `net.acme`) and any orginization + # specific subdivisions. If the organization's top-level domain is `com`, + # the top-level domain is ommited (e.g. `google.com` appears as + # `google`). For example, `google.storage` and + # `google.firebase.analytics`. + # 2. resource type: The type of resource on which event ocurs. For + # example, the Google Cloud Storage API includes the type `object`. + # 3. action: The action that generates the event. For example, actions for + # a Google Cloud Storage Object include 'finalize' and 'delete'. + # These parts are lower case and joined by '.'. + # Corresponds to the JSON property `eventType` + # @return [String] + attr_accessor :event_type + + # Describes the policy in case of function's execution failure. + # If empty, then defaults to ignoring failures (i.e. not retrying them). + # Corresponds to the JSON property `failurePolicy` + # @return [Google::Apis::CloudfunctionsV1::FailurePolicy] + attr_accessor :failure_policy + + # Required. The resource(s) from which to observe events, for example, + # `projects/_/buckets/myBucket`. + # Not all syntactically correct values are accepted by all services. For + # example: + # 1. The authorization model must support it. Google Cloud Functions + # only allows EventTriggers to be deployed that observe resources in the + # same project as the `CloudFunction`. + # 2. The resource type must match the pattern expected for an + # `event_type`. For example, an `EventTrigger` that has an + # `event_type` of "google.pubsub.topic.publish" should have a resource + # that matches Google Cloud Pub/Sub topics. + # Additionally, some services may support short names when creating an + # `EventTrigger`. These will always be returned in the normalized "long" + # format. + # See each *service's* documentation for supported formats. + # Corresponds to the JSON property `resource` + # @return [String] + attr_accessor :resource + + # The hostname of the service that should be observed. + # If no string is provided, the default service implementing the API will + # be used. For example, `storage.googleapis.com` is the default for all + # event types in the `google.storage` namespace. + # Corresponds to the JSON property `service` + # @return [String] + attr_accessor :service + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @event_type = args[:event_type] if args.key?(:event_type) + @failure_policy = args[:failure_policy] if args.key?(:failure_policy) + @resource = args[:resource] if args.key?(:resource) + @service = args[:service] if args.key?(:service) + end + end + + # Describes the policy in case of function's execution failure. + # If empty, then defaults to ignoring failures (i.e. not retrying them). + class FailurePolicy + include Google::Apis::Core::Hashable + + # Describes the retry policy in case of function's execution failure. + # A function execution will be retried on any failure. + # A failed execution will be retried up to 7 days with an exponential backoff + # (capped at 10 seconds). + # Retried execution is charged as any other execution. + # Corresponds to the JSON property `retry` + # @return [Google::Apis::CloudfunctionsV1::Retry] + attr_accessor :retry + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @retry = args[:retry] if args.key?(:retry) + end + end + + # Request of `GenerateDownloadUrl` method. + class GenerateDownloadUrlRequest + include Google::Apis::Core::Hashable + + # The optional version of function. If not set, default, current version + # is used. + # Corresponds to the JSON property `versionId` + # @return [Fixnum] + attr_accessor :version_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @version_id = args[:version_id] if args.key?(:version_id) + end + end + + # Response of `GenerateDownloadUrl` method. + class GenerateDownloadUrlResponse + include Google::Apis::Core::Hashable + + # The generated Google Cloud Storage signed URL that should be used for + # function source code download. + # Corresponds to the JSON property `downloadUrl` + # @return [String] + attr_accessor :download_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @download_url = args[:download_url] if args.key?(:download_url) + end + end + + # Request of `GenerateSourceUploadUrl` method. + class GenerateUploadUrlRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Response of `GenerateSourceUploadUrl` method. + class GenerateUploadUrlResponse + include Google::Apis::Core::Hashable + + # The generated Google Cloud Storage signed URL that should be used for a + # function source code upload. The uploaded file should be a zip archive + # which contains a function. + # Corresponds to the JSON property `uploadUrl` + # @return [String] + attr_accessor :upload_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @upload_url = args[:upload_url] if args.key?(:upload_url) + end + end + + # Describes HttpsTrigger, could be used to connect web hooks to function. + class HttpsTrigger + include Google::Apis::Core::Hashable + + # Output only. The deployed url for the function. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @url = args[:url] if args.key?(:url) + end + end + + # Response for the `ListFunctions` method. + class ListFunctionsResponse + include Google::Apis::Core::Hashable + + # The functions that match the request. + # Corresponds to the JSON property `functions` + # @return [Array] + attr_accessor :functions + + # If not empty, indicates that there may be more functions that match + # the request; this value should be passed in a new + # google.cloud.functions.v1.ListFunctionsRequest + # to get more functions. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @functions = args[:functions] if args.key?(:functions) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # The response message for Locations.ListLocations. class ListLocationsResponse include Google::Apis::Core::Hashable @@ -209,6 +595,51 @@ module Google end end + # Metadata describing an Operation + class OperationMetadataV1 + include Google::Apis::Core::Hashable + + # The original request that started the operation. + # Corresponds to the JSON property `request` + # @return [Hash] + attr_accessor :request + + # Target of the operation - for example + # projects/project-1/locations/region-1/functions/function-1 + # Corresponds to the JSON property `target` + # @return [String] + attr_accessor :target + + # Type of operation. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # The last update timestamp of the operation. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + # Version id of the function created or updated by an API call. + # This field is only pupulated for Create and Update operations. + # Corresponds to the JSON property `versionId` + # @return [Fixnum] + attr_accessor :version_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @request = args[:request] if args.key?(:request) + @target = args[:target] if args.key?(:target) + @type = args[:type] if args.key?(:type) + @update_time = args[:update_time] if args.key?(:update_time) + @version_id = args[:version_id] if args.key?(:version_id) + end + end + # Metadata describing an Operation class OperationMetadataV1Beta2 include Google::Apis::Core::Hashable @@ -229,6 +660,11 @@ module Google # @return [String] attr_accessor :type + # The last update timestamp of the operation. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + # Version id of the function created or updated by an API call. # This field is only pupulated for Create and Update operations. # Corresponds to the JSON property `versionId` @@ -244,10 +680,68 @@ module Google @request = args[:request] if args.key?(:request) @target = args[:target] if args.key?(:target) @type = args[:type] if args.key?(:type) + @update_time = args[:update_time] if args.key?(:update_time) @version_id = args[:version_id] if args.key?(:version_id) end end + # Describes the retry policy in case of function's execution failure. + # A function execution will be retried on any failure. + # A failed execution will be retried up to 7 days with an exponential backoff + # (capped at 10 seconds). + # Retried execution is charged as any other execution. + class Retry + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Describes SourceRepository, used to represent parameters related to + # source repository where a function is hosted. + class SourceRepository + include Google::Apis::Core::Hashable + + # Output only. The URL pointing to the hosted repository where the function + # were defined at the time of deployment. It always points to a specific + # commit in the format described above. + # Corresponds to the JSON property `deployedUrl` + # @return [String] + attr_accessor :deployed_url + + # The URL pointing to the hosted repository where the function is defined. + # There are supported Cloud Source Repository URLs in the following + # formats: + # To refer to a specific commit: + # `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` + # To refer to a moveable alias (branch): + # `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/ + # paths/*` + # In particular, to refer to HEAD use `master` moveable alias. + # To refer to a specific fixed alias (tag): + # `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/ + # *` + # You may omit `paths/*` if you want to use the main directory. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @deployed_url = args[:deployed_url] if args.key?(:deployed_url) + @url = args[:url] if args.key?(:url) + end + end + # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: diff --git a/generated/google/apis/cloudfunctions_v1/representations.rb b/generated/google/apis/cloudfunctions_v1/representations.rb index d6d301ca3..2eada3a06 100644 --- a/generated/google/apis/cloudfunctions_v1/representations.rb +++ b/generated/google/apis/cloudfunctions_v1/representations.rb @@ -22,6 +22,72 @@ module Google module Apis module CloudfunctionsV1 + class CallFunctionRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CallFunctionResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CloudFunction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EventTrigger + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FailurePolicy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GenerateDownloadUrlRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GenerateDownloadUrlResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GenerateUploadUrlRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GenerateUploadUrlResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class HttpsTrigger + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListFunctionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListLocationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -46,18 +112,138 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class OperationMetadataV1 + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class OperationMetadataV1Beta2 class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class Retry + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SourceRepository + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Status class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class CallFunctionRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :data, as: 'data' + end + end + + class CallFunctionResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :error, as: 'error' + property :execution_id, as: 'executionId' + property :result, as: 'result' + end + end + + class CloudFunction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :available_memory_mb, as: 'availableMemoryMb' + property :description, as: 'description' + property :entry_point, as: 'entryPoint' + property :event_trigger, as: 'eventTrigger', class: Google::Apis::CloudfunctionsV1::EventTrigger, decorator: Google::Apis::CloudfunctionsV1::EventTrigger::Representation + + property :https_trigger, as: 'httpsTrigger', class: Google::Apis::CloudfunctionsV1::HttpsTrigger, decorator: Google::Apis::CloudfunctionsV1::HttpsTrigger::Representation + + hash :labels, as: 'labels' + property :name, as: 'name' + property :service_account_email, as: 'serviceAccountEmail' + property :source_archive_url, as: 'sourceArchiveUrl' + property :source_repository, as: 'sourceRepository', class: Google::Apis::CloudfunctionsV1::SourceRepository, decorator: Google::Apis::CloudfunctionsV1::SourceRepository::Representation + + property :source_upload_url, as: 'sourceUploadUrl' + property :status, as: 'status' + property :timeout, as: 'timeout' + property :update_time, as: 'updateTime' + property :version_id, :numeric_string => true, as: 'versionId' + end + end + + class EventTrigger + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :event_type, as: 'eventType' + property :failure_policy, as: 'failurePolicy', class: Google::Apis::CloudfunctionsV1::FailurePolicy, decorator: Google::Apis::CloudfunctionsV1::FailurePolicy::Representation + + property :resource, as: 'resource' + property :service, as: 'service' + end + end + + class FailurePolicy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :retry, as: 'retry', class: Google::Apis::CloudfunctionsV1::Retry, decorator: Google::Apis::CloudfunctionsV1::Retry::Representation + + end + end + + class GenerateDownloadUrlRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :version_id, :numeric_string => true, as: 'versionId' + end + end + + class GenerateDownloadUrlResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :download_url, as: 'downloadUrl' + end + end + + class GenerateUploadUrlRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GenerateUploadUrlResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :upload_url, as: 'uploadUrl' + end + end + + class HttpsTrigger + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :url, as: 'url' + end + end + + class ListFunctionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :functions, as: 'functions', class: Google::Apis::CloudfunctionsV1::CloudFunction, decorator: Google::Apis::CloudfunctionsV1::CloudFunction::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + class ListLocationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -98,16 +284,42 @@ module Google end end + class OperationMetadataV1 + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :request, as: 'request' + property :target, as: 'target' + property :type, as: 'type' + property :update_time, as: 'updateTime' + property :version_id, :numeric_string => true, as: 'versionId' + end + end + class OperationMetadataV1Beta2 # @private class Representation < Google::Apis::Core::JsonRepresentation hash :request, as: 'request' property :target, as: 'target' property :type, as: 'type' + property :update_time, as: 'updateTime' property :version_id, :numeric_string => true, as: 'versionId' end end + class Retry + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class SourceRepository + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :deployed_url, as: 'deployedUrl' + property :url, as: 'url' + end + end + class Status # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/cloudfunctions_v1/service.rb b/generated/google/apis/cloudfunctions_v1/service.rb index c490dcab1..8770ce0a1 100644 --- a/generated/google/apis/cloudfunctions_v1/service.rb +++ b/generated/google/apis/cloudfunctions_v1/service.rb @@ -165,6 +165,294 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end + + # Invokes synchronously deployed function. To be used for testing, very + # limited traffic allowed. + # @param [String] name + # The name of the function to be called. + # @param [Google::Apis::CloudfunctionsV1::CallFunctionRequest] call_function_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudfunctionsV1::CallFunctionResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudfunctionsV1::CallFunctionResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def call_function(name, call_function_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:call', options) + command.request_representation = Google::Apis::CloudfunctionsV1::CallFunctionRequest::Representation + command.request_object = call_function_request_object + command.response_representation = Google::Apis::CloudfunctionsV1::CallFunctionResponse::Representation + command.response_class = Google::Apis::CloudfunctionsV1::CallFunctionResponse + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new function. If a function with the given name already exists in + # the specified project, the long running operation will return + # `ALREADY_EXISTS` error. + # @param [String] location + # The project and location in which the function should be created, specified + # in the format `projects/*/locations/*` + # @param [Google::Apis::CloudfunctionsV1::CloudFunction] cloud_function_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudfunctionsV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudfunctionsV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_function(location, cloud_function_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+location}/functions', options) + command.request_representation = Google::Apis::CloudfunctionsV1::CloudFunction::Representation + command.request_object = cloud_function_object + command.response_representation = Google::Apis::CloudfunctionsV1::Operation::Representation + command.response_class = Google::Apis::CloudfunctionsV1::Operation + command.params['location'] = location unless location.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a function with the given name from the specified project. If the + # given function is used by some trigger, the trigger will be updated to + # remove this function. + # @param [String] name + # The name of the function which should be deleted. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudfunctionsV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudfunctionsV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_function(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::CloudfunctionsV1::Operation::Representation + command.response_class = Google::Apis::CloudfunctionsV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns a signed URL for downloading deployed function source code. + # The URL is only valid for a limited period and should be used within + # minutes after generation. + # For more information about the signed URL usage see: + # https://cloud.google.com/storage/docs/access-control/signed-urls + # @param [String] name + # The name of function for which source code Google Cloud Storage signed + # URL should be generated. + # @param [Google::Apis::CloudfunctionsV1::GenerateDownloadUrlRequest] generate_download_url_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudfunctionsV1::GenerateDownloadUrlResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudfunctionsV1::GenerateDownloadUrlResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def generate_function_download_url(name, generate_download_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:generateDownloadUrl', options) + command.request_representation = Google::Apis::CloudfunctionsV1::GenerateDownloadUrlRequest::Representation + command.request_object = generate_download_url_request_object + command.response_representation = Google::Apis::CloudfunctionsV1::GenerateDownloadUrlResponse::Representation + command.response_class = Google::Apis::CloudfunctionsV1::GenerateDownloadUrlResponse + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns a signed URL for uploading a function source code. + # For more information about the signed URL usage see: + # https://cloud.google.com/storage/docs/access-control/signed-urls + # Once the function source code upload is complete, the used signed + # URL should be provided in CreateFunction or UpdateFunction request + # as a reference to the function source code. + # @param [String] parent + # The project and location in which the Google Cloud Storage signed URL + # should be generated, specified in the format `projects/*/locations/* + # @param [Google::Apis::CloudfunctionsV1::GenerateUploadUrlRequest] generate_upload_url_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudfunctionsV1::GenerateUploadUrlResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudfunctionsV1::GenerateUploadUrlResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def generate_function_upload_url(parent, generate_upload_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/functions:generateUploadUrl', options) + command.request_representation = Google::Apis::CloudfunctionsV1::GenerateUploadUrlRequest::Representation + command.request_object = generate_upload_url_request_object + command.response_representation = Google::Apis::CloudfunctionsV1::GenerateUploadUrlResponse::Representation + command.response_class = Google::Apis::CloudfunctionsV1::GenerateUploadUrlResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns a function with the given name from the requested project. + # @param [String] name + # The name of the function which details should be obtained. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudfunctionsV1::CloudFunction] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudfunctionsV1::CloudFunction] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_function(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::CloudfunctionsV1::CloudFunction::Representation + command.response_class = Google::Apis::CloudfunctionsV1::CloudFunction + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns a list of functions that belong to the requested project. + # @param [String] parent + # The project and location from which the function should be listed, + # specified in the format `projects/*/locations/*` + # If you want to list functions in all locations, use "-" in place of a + # location. + # @param [Fixnum] page_size + # Maximum number of functions to return per call. + # @param [String] page_token + # The value returned by the last + # `ListFunctionsResponse`; indicates that + # this is a continuation of a prior `ListFunctions` call, and that the + # system should return the next page of data. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudfunctionsV1::ListFunctionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudfunctionsV1::ListFunctionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_functions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/functions', options) + command.response_representation = Google::Apis::CloudfunctionsV1::ListFunctionsResponse::Representation + command.response_class = Google::Apis::CloudfunctionsV1::ListFunctionsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates existing function. + # @param [String] name + # A user-defined name of the function. Function names must be unique + # globally and match pattern `projects/*/locations/*/functions/*` + # @param [Google::Apis::CloudfunctionsV1::CloudFunction] cloud_function_object + # @param [String] update_mask + # Required list of fields to be updated in this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudfunctionsV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudfunctionsV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_location_function(name, cloud_function_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::CloudfunctionsV1::CloudFunction::Representation + command.request_object = cloud_function_object + command.response_representation = Google::Apis::CloudfunctionsV1::Operation::Representation + command.response_class = Google::Apis::CloudfunctionsV1::Operation + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end protected diff --git a/generated/google/apis/cloudfunctions_v1beta2.rb b/generated/google/apis/cloudfunctions_v1beta2.rb index f073b43f8..e26de2323 100644 --- a/generated/google/apis/cloudfunctions_v1beta2.rb +++ b/generated/google/apis/cloudfunctions_v1beta2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/functions module CloudfunctionsV1beta2 VERSION = 'V1beta2' - REVISION = '20170926' + REVISION = '20171101' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudfunctions_v1beta2/classes.rb b/generated/google/apis/cloudfunctions_v1beta2/classes.rb index 13b6c4bc9..94faf931c 100644 --- a/generated/google/apis/cloudfunctions_v1beta2/classes.rb +++ b/generated/google/apis/cloudfunctions_v1beta2/classes.rb @@ -157,6 +157,12 @@ module Google # @return [String] attr_accessor :source_repository_url + # The Google Cloud Storage signed URL used for source uploading, generated + # by google.cloud.functions.v1beta2.GenerateUploadUrl + # Corresponds to the JSON property `sourceUploadUrl` + # @return [String] + attr_accessor :source_upload_url + # Output only. Status of the function deployment. # Corresponds to the JSON property `status` # @return [String] @@ -198,6 +204,7 @@ module Google @source_archive_url = args[:source_archive_url] if args.key?(:source_archive_url) @source_repository = args[:source_repository] if args.key?(:source_repository) @source_repository_url = args[:source_repository_url] if args.key?(:source_repository_url) + @source_upload_url = args[:source_upload_url] if args.key?(:source_upload_url) @status = args[:status] if args.key?(:status) @timeout = args[:timeout] if args.key?(:timeout) @update_time = args[:update_time] if args.key?(:update_time) @@ -240,7 +247,7 @@ module Google # The hostname of the service that should be observed. # If no string is provided, the default service implementing the API will # be used. For example, `storage.googleapis.com` is the default for all - # event types in the 'google.storage` namespace. + # event types in the `google.storage` namespace. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service @@ -282,6 +289,79 @@ module Google end end + # Request of `GenerateDownloadUrl` method. + class GenerateDownloadUrlRequest + include Google::Apis::Core::Hashable + + # The optional version of function. + # Corresponds to the JSON property `versionId` + # @return [Fixnum] + attr_accessor :version_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @version_id = args[:version_id] if args.key?(:version_id) + end + end + + # Response of `GenerateDownloadUrl` method. + class GenerateDownloadUrlResponse + include Google::Apis::Core::Hashable + + # The generated Google Cloud Storage signed URL that should be used for + # function source code download. + # Corresponds to the JSON property `downloadUrl` + # @return [String] + attr_accessor :download_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @download_url = args[:download_url] if args.key?(:download_url) + end + end + + # Request of `GenerateUploadUrl` method. + class GenerateUploadUrlRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Response of `GenerateUploadUrl` method. + class GenerateUploadUrlResponse + include Google::Apis::Core::Hashable + + # The generated Google Cloud Storage signed URL that should be used for a + # function source code upload. The uploaded file should be a zip archive + # which contains a function. + # Corresponds to the JSON property `uploadUrl` + # @return [String] + attr_accessor :upload_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @upload_url = args[:upload_url] if args.key?(:upload_url) + end + end + # Describes HTTPSTrigger, could be used to connect web hooks to function. class HttpsTrigger include Google::Apis::Core::Hashable @@ -516,6 +596,51 @@ module Google end end + # Metadata describing an Operation + class OperationMetadataV1 + include Google::Apis::Core::Hashable + + # The original request that started the operation. + # Corresponds to the JSON property `request` + # @return [Hash] + attr_accessor :request + + # Target of the operation - for example + # projects/project-1/locations/region-1/functions/function-1 + # Corresponds to the JSON property `target` + # @return [String] + attr_accessor :target + + # Type of operation. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # The last update timestamp of the operation. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + # Version id of the function created or updated by an API call. + # This field is only pupulated for Create and Update operations. + # Corresponds to the JSON property `versionId` + # @return [Fixnum] + attr_accessor :version_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @request = args[:request] if args.key?(:request) + @target = args[:target] if args.key?(:target) + @type = args[:type] if args.key?(:type) + @update_time = args[:update_time] if args.key?(:update_time) + @version_id = args[:version_id] if args.key?(:version_id) + end + end + # Metadata describing an Operation class OperationMetadataV1Beta2 include Google::Apis::Core::Hashable @@ -536,6 +661,11 @@ module Google # @return [String] attr_accessor :type + # The last update timestamp of the operation. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + # Version id of the function created or updated by an API call. # This field is only pupulated for Create and Update operations. # Corresponds to the JSON property `versionId` @@ -551,6 +681,7 @@ module Google @request = args[:request] if args.key?(:request) @target = args[:target] if args.key?(:target) @type = args[:type] if args.key?(:type) + @update_time = args[:update_time] if args.key?(:update_time) @version_id = args[:version_id] if args.key?(:version_id) end end diff --git a/generated/google/apis/cloudfunctions_v1beta2/representations.rb b/generated/google/apis/cloudfunctions_v1beta2/representations.rb index f20e6ee20..9a2e9c1cf 100644 --- a/generated/google/apis/cloudfunctions_v1beta2/representations.rb +++ b/generated/google/apis/cloudfunctions_v1beta2/representations.rb @@ -52,6 +52,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GenerateDownloadUrlRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GenerateDownloadUrlResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GenerateUploadUrlRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GenerateUploadUrlResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class HttpsTrigger class Representation < Google::Apis::Core::JsonRepresentation; end @@ -88,6 +112,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class OperationMetadataV1 + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class OperationMetadataV1Beta2 class Representation < Google::Apis::Core::JsonRepresentation; end @@ -145,6 +175,7 @@ module Google property :source_repository, as: 'sourceRepository', class: Google::Apis::CloudfunctionsV1beta2::SourceRepository, decorator: Google::Apis::CloudfunctionsV1beta2::SourceRepository::Representation property :source_repository_url, as: 'sourceRepositoryUrl' + property :source_upload_url, as: 'sourceUploadUrl' property :status, as: 'status' property :timeout, as: 'timeout' property :update_time, as: 'updateTime' @@ -171,6 +202,33 @@ module Google end end + class GenerateDownloadUrlRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :version_id, :numeric_string => true, as: 'versionId' + end + end + + class GenerateDownloadUrlResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :download_url, as: 'downloadUrl' + end + end + + class GenerateUploadUrlRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GenerateUploadUrlResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :upload_url, as: 'uploadUrl' + end + end + class HttpsTrigger # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -227,12 +285,24 @@ module Google end end + class OperationMetadataV1 + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :request, as: 'request' + property :target, as: 'target' + property :type, as: 'type' + property :update_time, as: 'updateTime' + property :version_id, :numeric_string => true, as: 'versionId' + end + end + class OperationMetadataV1Beta2 # @private class Representation < Google::Apis::Core::JsonRepresentation hash :request, as: 'request' property :target, as: 'target' property :type, as: 'type' + property :update_time, as: 'updateTime' property :version_id, :numeric_string => true, as: 'versionId' end end diff --git a/generated/google/apis/cloudfunctions_v1beta2/service.rb b/generated/google/apis/cloudfunctions_v1beta2/service.rb index 139c71474..967a34b7b 100644 --- a/generated/google/apis/cloudfunctions_v1beta2/service.rb +++ b/generated/google/apis/cloudfunctions_v1beta2/service.rb @@ -268,6 +268,83 @@ module Google execute_or_queue_command(command, &block) end + # Returns a signed URL for downloading deployed function source code. + # The URL is only valid for a limited period and should be used within + # minutes after generation. + # For more information about the signed URL usage see: + # https://cloud.google.com/storage/docs/access-control/signed-urls + # @param [String] name + # The name of function for which source code Google Cloud Storage signed + # URL should be generated. + # @param [Google::Apis::CloudfunctionsV1beta2::GenerateDownloadUrlRequest] generate_download_url_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudfunctionsV1beta2::GenerateDownloadUrlResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudfunctionsV1beta2::GenerateDownloadUrlResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def generate_function_download_url(name, generate_download_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta2/{+name}:generateDownloadUrl', options) + command.request_representation = Google::Apis::CloudfunctionsV1beta2::GenerateDownloadUrlRequest::Representation + command.request_object = generate_download_url_request_object + command.response_representation = Google::Apis::CloudfunctionsV1beta2::GenerateDownloadUrlResponse::Representation + command.response_class = Google::Apis::CloudfunctionsV1beta2::GenerateDownloadUrlResponse + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns a signed URL for uploading a function source code. + # For more information about the signed URL usage see: + # https://cloud.google.com/storage/docs/access-control/signed-urls + # Once the function source code upload is complete, the used signed + # URL should be provided in CreateFunction or UpdateFunction request + # as a reference to the function source code. + # @param [String] parent + # The project and location in which the Google Cloud Storage signed URL + # should be generated, specified in the format `projects/*/locations/* + # @param [Google::Apis::CloudfunctionsV1beta2::GenerateUploadUrlRequest] generate_upload_url_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudfunctionsV1beta2::GenerateUploadUrlResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudfunctionsV1beta2::GenerateUploadUrlResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def generate_function_upload_url(parent, generate_upload_url_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta2/{+parent}/functions:generateUploadUrl', options) + command.request_representation = Google::Apis::CloudfunctionsV1beta2::GenerateUploadUrlRequest::Representation + command.request_object = generate_upload_url_request_object + command.response_representation = Google::Apis::CloudfunctionsV1beta2::GenerateUploadUrlResponse::Representation + command.response_class = Google::Apis::CloudfunctionsV1beta2::GenerateUploadUrlResponse + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Returns a function with the given name from the requested project. # @param [String] name # The name of the function which details should be obtained. diff --git a/generated/google/apis/cloudiot_v1.rb b/generated/google/apis/cloudiot_v1.rb index deb2ded4d..4827e9fa7 100644 --- a/generated/google/apis/cloudiot_v1.rb +++ b/generated/google/apis/cloudiot_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/iot module CloudiotV1 VERSION = 'V1' - REVISION = '20170922' + REVISION = '20171110' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudiot_v1/classes.rb b/generated/google/apis/cloudiot_v1/classes.rb index 61c19e1b0..53deb582e 100644 --- a/generated/google/apis/cloudiot_v1/classes.rb +++ b/generated/google/apis/cloudiot_v1/classes.rb @@ -466,7 +466,11 @@ module Google # The configuration for notification of telemetry events received from the # device. All telemetry events that were successfully published by the # device and acknowledged by Cloud IoT Core are guaranteed to be - # delivered to Cloud Pub/Sub. Only the first configuration is used. + # delivered to Cloud Pub/Sub. Only the first configuration is used. If you + # try to publish a device telemetry event using MQTT without specifying a + # Cloud Pub/Sub topic for the device's registry, the connection closes + # automatically. If you try to do so using an HTTP connection, an error + # is returned. # Corresponds to the JSON property `eventNotificationConfigs` # @return [Array] attr_accessor :event_notification_configs diff --git a/generated/google/apis/cloudiot_v1/service.rb b/generated/google/apis/cloudiot_v1/service.rb index 896c2e2ba..0de4c5e14 100644 --- a/generated/google/apis/cloudiot_v1/service.rb +++ b/generated/google/apis/cloudiot_v1/service.rb @@ -231,8 +231,8 @@ module Google # Only updates the `device_registry` fields indicated by this mask. # The field mask must not be empty, and it must not contain fields that # are immutable or only set by the server. - # Mutable top-level fields: `event_notification_config`, `mqtt_config`, and - # `state_notification_config`. + # Mutable top-level fields: `event_notification_config`, `http_config`, + # `mqtt_config`, and `state_notification_config`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -406,6 +406,9 @@ module Google # The name of the device. For example, # `projects/p0/locations/us-central1/registries/registry0/devices/device0` or # `projects/p0/locations/us-central1/registries/registry0/devices/`num_id``. + # @param [String] field_mask + # The fields of the `Device` resource to be returned in the response. If the + # field mask is unset or empty, all fields are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -423,11 +426,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_location_registry_device(name, fields: nil, quota_user: nil, options: nil, &block) + def get_project_location_registry_device(name, field_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::CloudiotV1::Device::Representation command.response_class = Google::Apis::CloudiotV1::Device command.params['name'] = name unless name.nil? + command.query['fieldMask'] = field_mask unless field_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) diff --git a/generated/google/apis/cloudiot_v1beta1.rb b/generated/google/apis/cloudiot_v1beta1.rb index c27383b2c..996988fc2 100644 --- a/generated/google/apis/cloudiot_v1beta1.rb +++ b/generated/google/apis/cloudiot_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/iot module CloudiotV1beta1 VERSION = 'V1beta1' - REVISION = '20170922' + REVISION = '20171011' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudkms_v1.rb b/generated/google/apis/cloudkms_v1.rb index cff9242e9..a708edabb 100644 --- a/generated/google/apis/cloudkms_v1.rb +++ b/generated/google/apis/cloudkms_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/kms/ module CloudkmsV1 VERSION = 'V1' - REVISION = '20170829' + REVISION = '20171114' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudkms_v1/classes.rb b/generated/google/apis/cloudkms_v1/classes.rb index f38b42eca..12504fc9e 100644 --- a/generated/google/apis/cloudkms_v1/classes.rb +++ b/generated/google/apis/cloudkms_v1/classes.rb @@ -206,7 +206,8 @@ module Google # @return [String] attr_accessor :create_time - # Labels with user defined metadata. + # Labels with user-defined metadata. For more information, see + # [Labeling CryptoKeys](/kms/docs/labeling-keys). # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels diff --git a/generated/google/apis/cloudmonitoring_v2beta2/classes.rb b/generated/google/apis/cloudmonitoring_v2beta2/classes.rb deleted file mode 100644 index 7824ebb0a..000000000 --- a/generated/google/apis/cloudmonitoring_v2beta2/classes.rb +++ /dev/null @@ -1,679 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module CloudmonitoringV2beta2 - - # The response of cloudmonitoring.metricDescriptors.delete. - class DeleteMetricDescriptorResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string " - # cloudmonitoring#deleteMetricDescriptorResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - end - end - - # The request of cloudmonitoring.metricDescriptors.list. - class ListMetricDescriptorsRequest - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string " - # cloudmonitoring#listMetricDescriptorsRequest". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - end - end - - # The response of cloudmonitoring.metricDescriptors.list. - class ListMetricDescriptorsResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string " - # cloudmonitoring#listMetricDescriptorsResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The returned metric descriptors. - # Corresponds to the JSON property `metrics` - # @return [Array] - attr_accessor :metrics - - # Pagination token. If present, indicates that additional results are available - # for retrieval. To access the results past the pagination limit, pass this - # value to the pageToken query parameter. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @metrics = args[:metrics] if args.key?(:metrics) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # The request of cloudmonitoring.timeseriesDescriptors.list - class ListTimeseriesDescriptorsRequest - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string " - # cloudmonitoring#listTimeseriesDescriptorsRequest". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - end - end - - # The response of cloudmonitoring.timeseriesDescriptors.list - class ListTimeseriesDescriptorsResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string " - # cloudmonitoring#listTimeseriesDescriptorsResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Pagination token. If present, indicates that additional results are available - # for retrieval. To access the results past the pagination limit, set this value - # to the pageToken query parameter. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The oldest timestamp of the interval of this query, as an RFC 3339 string. - # Corresponds to the JSON property `oldest` - # @return [DateTime] - attr_accessor :oldest - - # The returned time series descriptors. - # Corresponds to the JSON property `timeseries` - # @return [Array] - attr_accessor :timeseries - - # The youngest timestamp of the interval of this query, as an RFC 3339 string. - # Corresponds to the JSON property `youngest` - # @return [DateTime] - attr_accessor :youngest - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @oldest = args[:oldest] if args.key?(:oldest) - @timeseries = args[:timeseries] if args.key?(:timeseries) - @youngest = args[:youngest] if args.key?(:youngest) - end - end - - # The request of cloudmonitoring.timeseries.list - class ListTimeseriesRequest - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string " - # cloudmonitoring#listTimeseriesRequest". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - end - end - - # The response of cloudmonitoring.timeseries.list - class ListTimeseriesResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string " - # cloudmonitoring#listTimeseriesResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Pagination token. If present, indicates that additional results are available - # for retrieval. To access the results past the pagination limit, set the - # pageToken query parameter to this value. All of the points of a time series - # will be returned before returning any point of the subsequent time series. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The oldest timestamp of the interval of this query as an RFC 3339 string. - # Corresponds to the JSON property `oldest` - # @return [DateTime] - attr_accessor :oldest - - # The returned time series. - # Corresponds to the JSON property `timeseries` - # @return [Array] - attr_accessor :timeseries - - # The youngest timestamp of the interval of this query as an RFC 3339 string. - # Corresponds to the JSON property `youngest` - # @return [DateTime] - attr_accessor :youngest - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @oldest = args[:oldest] if args.key?(:oldest) - @timeseries = args[:timeseries] if args.key?(:timeseries) - @youngest = args[:youngest] if args.key?(:youngest) - end - end - - # A metricDescriptor defines the name, label keys, and data type of a particular - # metric. - class MetricDescriptor - include Google::Apis::Core::Hashable - - # Description of this metric. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Labels defined for this metric. - # Corresponds to the JSON property `labels` - # @return [Array] - attr_accessor :labels - - # The name of this metric. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The project ID to which the metric belongs. - # Corresponds to the JSON property `project` - # @return [String] - attr_accessor :project - - # A type in a metric contains information about how the metric is collected and - # what its data points look like. - # Corresponds to the JSON property `typeDescriptor` - # @return [Google::Apis::CloudmonitoringV2beta2::MetricDescriptorTypeDescriptor] - attr_accessor :type_descriptor - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @description = args[:description] if args.key?(:description) - @labels = args[:labels] if args.key?(:labels) - @name = args[:name] if args.key?(:name) - @project = args[:project] if args.key?(:project) - @type_descriptor = args[:type_descriptor] if args.key?(:type_descriptor) - end - end - - # A label in a metric is a description of this metric, including the key of this - # description (what the description is), and the value for this description. - class MetricDescriptorLabelDescriptor - include Google::Apis::Core::Hashable - - # Label description. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Label key. - # Corresponds to the JSON property `key` - # @return [String] - attr_accessor :key - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @description = args[:description] if args.key?(:description) - @key = args[:key] if args.key?(:key) - end - end - - # A type in a metric contains information about how the metric is collected and - # what its data points look like. - class MetricDescriptorTypeDescriptor - include Google::Apis::Core::Hashable - - # The method of collecting data for the metric. See Metric types. - # Corresponds to the JSON property `metricType` - # @return [String] - attr_accessor :metric_type - - # The data type of of individual points in the metric's time series. See Metric - # value types. - # Corresponds to the JSON property `valueType` - # @return [String] - attr_accessor :value_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @metric_type = args[:metric_type] if args.key?(:metric_type) - @value_type = args[:value_type] if args.key?(:value_type) - end - end - - # Point is a single point in a time series. It consists of a start time, an end - # time, and a value. - class Point - include Google::Apis::Core::Hashable - - # The value of this data point. Either "true" or "false". - # Corresponds to the JSON property `boolValue` - # @return [Boolean] - attr_accessor :bool_value - alias_method :bool_value?, :bool_value - - # Distribution data point value type. When writing distribution points, try to - # be consistent with the boundaries of your buckets. If you must modify the - # bucket boundaries, then do so by merging, partitioning, or appending rather - # than skewing them. - # Corresponds to the JSON property `distributionValue` - # @return [Google::Apis::CloudmonitoringV2beta2::PointDistribution] - attr_accessor :distribution_value - - # The value of this data point as a double-precision floating-point number. - # Corresponds to the JSON property `doubleValue` - # @return [Float] - attr_accessor :double_value - - # The interval [start, end] is the time period to which the point's value - # applies. For gauge metrics, whose values are instantaneous measurements, this - # interval should be empty (start should equal end). For cumulative metrics (of - # which deltas and rates are special cases), the interval should be non-empty. - # Both start and end are RFC 3339 strings. - # Corresponds to the JSON property `end` - # @return [DateTime] - attr_accessor :end - - # The value of this data point as a 64-bit integer. - # Corresponds to the JSON property `int64Value` - # @return [Fixnum] - attr_accessor :int64_value - - # The interval [start, end] is the time period to which the point's value - # applies. For gauge metrics, whose values are instantaneous measurements, this - # interval should be empty (start should equal end). For cumulative metrics (of - # which deltas and rates are special cases), the interval should be non-empty. - # Both start and end are RFC 3339 strings. - # Corresponds to the JSON property `start` - # @return [DateTime] - attr_accessor :start - - # The value of this data point in string format. - # Corresponds to the JSON property `stringValue` - # @return [String] - attr_accessor :string_value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @bool_value = args[:bool_value] if args.key?(:bool_value) - @distribution_value = args[:distribution_value] if args.key?(:distribution_value) - @double_value = args[:double_value] if args.key?(:double_value) - @end = args[:end] if args.key?(:end) - @int64_value = args[:int64_value] if args.key?(:int64_value) - @start = args[:start] if args.key?(:start) - @string_value = args[:string_value] if args.key?(:string_value) - end - end - - # Distribution data point value type. When writing distribution points, try to - # be consistent with the boundaries of your buckets. If you must modify the - # bucket boundaries, then do so by merging, partitioning, or appending rather - # than skewing them. - class PointDistribution - include Google::Apis::Core::Hashable - - # The finite buckets. - # Corresponds to the JSON property `buckets` - # @return [Array] - attr_accessor :buckets - - # The overflow bucket is a special bucket that does not have the upperBound - # field; it includes all of the events that are no less than its lower bound. - # Corresponds to the JSON property `overflowBucket` - # @return [Google::Apis::CloudmonitoringV2beta2::PointDistributionOverflowBucket] - attr_accessor :overflow_bucket - - # The underflow bucket is a special bucket that does not have the lowerBound - # field; it includes all of the events that are less than its upper bound. - # Corresponds to the JSON property `underflowBucket` - # @return [Google::Apis::CloudmonitoringV2beta2::PointDistributionUnderflowBucket] - attr_accessor :underflow_bucket - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @buckets = args[:buckets] if args.key?(:buckets) - @overflow_bucket = args[:overflow_bucket] if args.key?(:overflow_bucket) - @underflow_bucket = args[:underflow_bucket] if args.key?(:underflow_bucket) - end - end - - # The histogram's bucket. Buckets that form the histogram of a distribution - # value. If the upper bound of a bucket, say U1, does not equal the lower bound - # of the next bucket, say L2, this means that there is no event in [U1, L2). - class PointDistributionBucket - include Google::Apis::Core::Hashable - - # The number of events whose values are in the interval defined by this bucket. - # Corresponds to the JSON property `count` - # @return [Fixnum] - attr_accessor :count - - # The lower bound of the value interval of this bucket (inclusive). - # Corresponds to the JSON property `lowerBound` - # @return [Float] - attr_accessor :lower_bound - - # The upper bound of the value interval of this bucket (exclusive). - # Corresponds to the JSON property `upperBound` - # @return [Float] - attr_accessor :upper_bound - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @count = args[:count] if args.key?(:count) - @lower_bound = args[:lower_bound] if args.key?(:lower_bound) - @upper_bound = args[:upper_bound] if args.key?(:upper_bound) - end - end - - # The overflow bucket is a special bucket that does not have the upperBound - # field; it includes all of the events that are no less than its lower bound. - class PointDistributionOverflowBucket - include Google::Apis::Core::Hashable - - # The number of events whose values are in the interval defined by this bucket. - # Corresponds to the JSON property `count` - # @return [Fixnum] - attr_accessor :count - - # The lower bound of the value interval of this bucket (inclusive). - # Corresponds to the JSON property `lowerBound` - # @return [Float] - attr_accessor :lower_bound - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @count = args[:count] if args.key?(:count) - @lower_bound = args[:lower_bound] if args.key?(:lower_bound) - end - end - - # The underflow bucket is a special bucket that does not have the lowerBound - # field; it includes all of the events that are less than its upper bound. - class PointDistributionUnderflowBucket - include Google::Apis::Core::Hashable - - # The number of events whose values are in the interval defined by this bucket. - # Corresponds to the JSON property `count` - # @return [Fixnum] - attr_accessor :count - - # The upper bound of the value interval of this bucket (exclusive). - # Corresponds to the JSON property `upperBound` - # @return [Float] - attr_accessor :upper_bound - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @count = args[:count] if args.key?(:count) - @upper_bound = args[:upper_bound] if args.key?(:upper_bound) - end - end - - # The monitoring data is organized as metrics and stored as data points that are - # recorded over time. Each data point represents information like the CPU - # utilization of your virtual machine. A historical record of these data points - # is called a time series. - class Timeseries - include Google::Apis::Core::Hashable - - # The data points of this time series. The points are listed in order of their - # end timestamp, from younger to older. - # Corresponds to the JSON property `points` - # @return [Array] - attr_accessor :points - - # TimeseriesDescriptor identifies a single time series. - # Corresponds to the JSON property `timeseriesDesc` - # @return [Google::Apis::CloudmonitoringV2beta2::TimeseriesDescriptor] - attr_accessor :timeseries_desc - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @points = args[:points] if args.key?(:points) - @timeseries_desc = args[:timeseries_desc] if args.key?(:timeseries_desc) - end - end - - # TimeseriesDescriptor identifies a single time series. - class TimeseriesDescriptor - include Google::Apis::Core::Hashable - - # The label's name. - # Corresponds to the JSON property `labels` - # @return [Hash] - attr_accessor :labels - - # The name of the metric. - # Corresponds to the JSON property `metric` - # @return [String] - attr_accessor :metric - - # The Developers Console project number to which this time series belongs. - # Corresponds to the JSON property `project` - # @return [String] - attr_accessor :project - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @labels = args[:labels] if args.key?(:labels) - @metric = args[:metric] if args.key?(:metric) - @project = args[:project] if args.key?(:project) - end - end - - # - class TimeseriesDescriptorLabel - include Google::Apis::Core::Hashable - - # The label's name. - # Corresponds to the JSON property `key` - # @return [String] - attr_accessor :key - - # The label's value. - # Corresponds to the JSON property `value` - # @return [String] - attr_accessor :value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @key = args[:key] if args.key?(:key) - @value = args[:value] if args.key?(:value) - end - end - - # When writing time series, TimeseriesPoint should be used instead of Timeseries, - # to enforce single point for each time series in the timeseries.write request. - class TimeseriesPoint - include Google::Apis::Core::Hashable - - # Point is a single point in a time series. It consists of a start time, an end - # time, and a value. - # Corresponds to the JSON property `point` - # @return [Google::Apis::CloudmonitoringV2beta2::Point] - attr_accessor :point - - # TimeseriesDescriptor identifies a single time series. - # Corresponds to the JSON property `timeseriesDesc` - # @return [Google::Apis::CloudmonitoringV2beta2::TimeseriesDescriptor] - attr_accessor :timeseries_desc - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @point = args[:point] if args.key?(:point) - @timeseries_desc = args[:timeseries_desc] if args.key?(:timeseries_desc) - end - end - - # The request of cloudmonitoring.timeseries.write - class WriteTimeseriesRequest - include Google::Apis::Core::Hashable - - # The label's name. - # Corresponds to the JSON property `commonLabels` - # @return [Hash] - attr_accessor :common_labels - - # Provide time series specific labels and the data points for each time series. - # The labels in timeseries and the common_labels should form a complete list of - # labels that required by the metric. - # Corresponds to the JSON property `timeseries` - # @return [Array] - attr_accessor :timeseries - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @common_labels = args[:common_labels] if args.key?(:common_labels) - @timeseries = args[:timeseries] if args.key?(:timeseries) - end - end - - # The response of cloudmonitoring.timeseries.write - class WriteTimeseriesResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string " - # cloudmonitoring#writeTimeseriesResponse". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - end - end - end - end -end diff --git a/generated/google/apis/cloudmonitoring_v2beta2/representations.rb b/generated/google/apis/cloudmonitoring_v2beta2/representations.rb deleted file mode 100644 index 2581ee171..000000000 --- a/generated/google/apis/cloudmonitoring_v2beta2/representations.rb +++ /dev/null @@ -1,353 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module CloudmonitoringV2beta2 - - class DeleteMetricDescriptorResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListMetricDescriptorsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListMetricDescriptorsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListTimeseriesDescriptorsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListTimeseriesDescriptorsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListTimeseriesRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListTimeseriesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class MetricDescriptor - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class MetricDescriptorLabelDescriptor - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class MetricDescriptorTypeDescriptor - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Point - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PointDistribution - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PointDistributionBucket - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PointDistributionOverflowBucket - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PointDistributionUnderflowBucket - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Timeseries - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TimeseriesDescriptor - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TimeseriesDescriptorLabel - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TimeseriesPoint - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class WriteTimeseriesRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class WriteTimeseriesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class DeleteMetricDescriptorResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - end - end - - class ListMetricDescriptorsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - end - end - - class ListMetricDescriptorsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - collection :metrics, as: 'metrics', class: Google::Apis::CloudmonitoringV2beta2::MetricDescriptor, decorator: Google::Apis::CloudmonitoringV2beta2::MetricDescriptor::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class ListTimeseriesDescriptorsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - end - end - - class ListTimeseriesDescriptorsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - property :oldest, as: 'oldest', type: DateTime - - collection :timeseries, as: 'timeseries', class: Google::Apis::CloudmonitoringV2beta2::TimeseriesDescriptor, decorator: Google::Apis::CloudmonitoringV2beta2::TimeseriesDescriptor::Representation - - property :youngest, as: 'youngest', type: DateTime - - end - end - - class ListTimeseriesRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - end - end - - class ListTimeseriesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - property :oldest, as: 'oldest', type: DateTime - - collection :timeseries, as: 'timeseries', class: Google::Apis::CloudmonitoringV2beta2::Timeseries, decorator: Google::Apis::CloudmonitoringV2beta2::Timeseries::Representation - - property :youngest, as: 'youngest', type: DateTime - - end - end - - class MetricDescriptor - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :description, as: 'description' - collection :labels, as: 'labels', class: Google::Apis::CloudmonitoringV2beta2::MetricDescriptorLabelDescriptor, decorator: Google::Apis::CloudmonitoringV2beta2::MetricDescriptorLabelDescriptor::Representation - - property :name, as: 'name' - property :project, as: 'project' - property :type_descriptor, as: 'typeDescriptor', class: Google::Apis::CloudmonitoringV2beta2::MetricDescriptorTypeDescriptor, decorator: Google::Apis::CloudmonitoringV2beta2::MetricDescriptorTypeDescriptor::Representation - - end - end - - class MetricDescriptorLabelDescriptor - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :description, as: 'description' - property :key, as: 'key' - end - end - - class MetricDescriptorTypeDescriptor - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :metric_type, as: 'metricType' - property :value_type, as: 'valueType' - end - end - - class Point - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :bool_value, as: 'boolValue' - property :distribution_value, as: 'distributionValue', class: Google::Apis::CloudmonitoringV2beta2::PointDistribution, decorator: Google::Apis::CloudmonitoringV2beta2::PointDistribution::Representation - - property :double_value, as: 'doubleValue' - property :end, as: 'end', type: DateTime - - property :int64_value, :numeric_string => true, as: 'int64Value' - property :start, as: 'start', type: DateTime - - property :string_value, as: 'stringValue' - end - end - - class PointDistribution - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :buckets, as: 'buckets', class: Google::Apis::CloudmonitoringV2beta2::PointDistributionBucket, decorator: Google::Apis::CloudmonitoringV2beta2::PointDistributionBucket::Representation - - property :overflow_bucket, as: 'overflowBucket', class: Google::Apis::CloudmonitoringV2beta2::PointDistributionOverflowBucket, decorator: Google::Apis::CloudmonitoringV2beta2::PointDistributionOverflowBucket::Representation - - property :underflow_bucket, as: 'underflowBucket', class: Google::Apis::CloudmonitoringV2beta2::PointDistributionUnderflowBucket, decorator: Google::Apis::CloudmonitoringV2beta2::PointDistributionUnderflowBucket::Representation - - end - end - - class PointDistributionBucket - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :count, :numeric_string => true, as: 'count' - property :lower_bound, as: 'lowerBound' - property :upper_bound, as: 'upperBound' - end - end - - class PointDistributionOverflowBucket - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :count, :numeric_string => true, as: 'count' - property :lower_bound, as: 'lowerBound' - end - end - - class PointDistributionUnderflowBucket - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :count, :numeric_string => true, as: 'count' - property :upper_bound, as: 'upperBound' - end - end - - class Timeseries - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :points, as: 'points', class: Google::Apis::CloudmonitoringV2beta2::Point, decorator: Google::Apis::CloudmonitoringV2beta2::Point::Representation - - property :timeseries_desc, as: 'timeseriesDesc', class: Google::Apis::CloudmonitoringV2beta2::TimeseriesDescriptor, decorator: Google::Apis::CloudmonitoringV2beta2::TimeseriesDescriptor::Representation - - end - end - - class TimeseriesDescriptor - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :labels, as: 'labels' - property :metric, as: 'metric' - property :project, as: 'project' - end - end - - class TimeseriesDescriptorLabel - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :key, as: 'key' - property :value, as: 'value' - end - end - - class TimeseriesPoint - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :point, as: 'point', class: Google::Apis::CloudmonitoringV2beta2::Point, decorator: Google::Apis::CloudmonitoringV2beta2::Point::Representation - - property :timeseries_desc, as: 'timeseriesDesc', class: Google::Apis::CloudmonitoringV2beta2::TimeseriesDescriptor, decorator: Google::Apis::CloudmonitoringV2beta2::TimeseriesDescriptor::Representation - - end - end - - class WriteTimeseriesRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :common_labels, as: 'commonLabels' - collection :timeseries, as: 'timeseries', class: Google::Apis::CloudmonitoringV2beta2::TimeseriesPoint, decorator: Google::Apis::CloudmonitoringV2beta2::TimeseriesPoint::Representation - - end - end - - class WriteTimeseriesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - end - end - end - end -end diff --git a/generated/google/apis/cloudmonitoring_v2beta2/service.rb b/generated/google/apis/cloudmonitoring_v2beta2/service.rb deleted file mode 100644 index 077df06e5..000000000 --- a/generated/google/apis/cloudmonitoring_v2beta2/service.rb +++ /dev/null @@ -1,453 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module CloudmonitoringV2beta2 - # Cloud Monitoring API - # - # Accesses Google Cloud Monitoring data. - # - # @example - # require 'google/apis/cloudmonitoring_v2beta2' - # - # Cloudmonitoring = Google::Apis::CloudmonitoringV2beta2 # Alias the module - # service = Cloudmonitoring::CloudMonitoringService.new - # - # @see https://cloud.google.com/monitoring/v2beta2/ - class CloudMonitoringService < Google::Apis::Core::BaseService - # @return [String] - # 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. - attr_accessor :key - - # @return [String] - # 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. - # Overrides userIp if both are provided. - attr_accessor :quota_user - - # @return [String] - # IP address of the site where the request originates. Use this if you want to - # enforce per-user limits. - attr_accessor :user_ip - - def initialize - super('https://www.googleapis.com/', 'cloudmonitoring/v2beta2/projects/') - @batch_path = 'batch/cloudmonitoring/v2beta2' - end - - # Create a new metric. - # @param [String] project - # The project id. The value can be the numeric project ID or string-based - # project name. - # @param [Google::Apis::CloudmonitoringV2beta2::MetricDescriptor] metric_descriptor_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # Overrides userIp if both are provided. - # @param [String] user_ip - # IP address of the site where the request originates. Use this if you want to - # enforce per-user limits. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudmonitoringV2beta2::MetricDescriptor] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudmonitoringV2beta2::MetricDescriptor] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_metric_descriptor(project, metric_descriptor_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{project}/metricDescriptors', options) - command.request_representation = Google::Apis::CloudmonitoringV2beta2::MetricDescriptor::Representation - command.request_object = metric_descriptor_object - command.response_representation = Google::Apis::CloudmonitoringV2beta2::MetricDescriptor::Representation - command.response_class = Google::Apis::CloudmonitoringV2beta2::MetricDescriptor - command.params['project'] = project unless project.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Delete an existing metric. - # @param [String] project - # The project ID to which the metric belongs. - # @param [String] metric - # Name of the metric. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # Overrides userIp if both are provided. - # @param [String] user_ip - # IP address of the site where the request originates. Use this if you want to - # enforce per-user limits. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudmonitoringV2beta2::DeleteMetricDescriptorResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudmonitoringV2beta2::DeleteMetricDescriptorResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_metric_descriptor(project, metric, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, '{project}/metricDescriptors/{metric}', options) - command.response_representation = Google::Apis::CloudmonitoringV2beta2::DeleteMetricDescriptorResponse::Representation - command.response_class = Google::Apis::CloudmonitoringV2beta2::DeleteMetricDescriptorResponse - command.params['project'] = project unless project.nil? - command.params['metric'] = metric unless metric.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # List metric descriptors that match the query. If the query is not set, then - # all of the metric descriptors will be returned. Large responses will be - # paginated, use the nextPageToken returned in the response to request - # subsequent pages of results by setting the pageToken query parameter to the - # value of the nextPageToken. - # @param [String] project - # The project id. The value can be the numeric project ID or string-based - # project name. - # @param [Google::Apis::CloudmonitoringV2beta2::ListMetricDescriptorsRequest] list_metric_descriptors_request_object - # @param [Fixnum] count - # Maximum number of metric descriptors per page. Used for pagination. If not - # specified, count = 100. - # @param [String] page_token - # The pagination token, which is used to page through large result sets. Set - # this value to the value of the nextPageToken to retrieve the next page of - # results. - # @param [String] query - # The query used to search against existing metrics. Separate keywords with a - # space; the service joins all keywords with AND, meaning that all keywords must - # match for a metric to be returned. If this field is omitted, all metrics are - # returned. If an empty string is passed with this field, no metrics are - # returned. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # Overrides userIp if both are provided. - # @param [String] user_ip - # IP address of the site where the request originates. Use this if you want to - # enforce per-user limits. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudmonitoringV2beta2::ListMetricDescriptorsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudmonitoringV2beta2::ListMetricDescriptorsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_metric_descriptors(project, list_metric_descriptors_request_object = nil, count: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}/metricDescriptors', options) - command.request_representation = Google::Apis::CloudmonitoringV2beta2::ListMetricDescriptorsRequest::Representation - command.request_object = list_metric_descriptors_request_object - command.response_representation = Google::Apis::CloudmonitoringV2beta2::ListMetricDescriptorsResponse::Representation - command.response_class = Google::Apis::CloudmonitoringV2beta2::ListMetricDescriptorsResponse - command.params['project'] = project unless project.nil? - command.query['count'] = count unless count.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['query'] = query unless query.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # List the data points of the time series that match the metric and labels - # values and that have data points in the interval. Large responses are - # paginated; use the nextPageToken returned in the response to request - # subsequent pages of results by setting the pageToken query parameter to the - # value of the nextPageToken. - # @param [String] project - # The project ID to which this time series belongs. The value can be the numeric - # project ID or string-based project name. - # @param [String] metric - # Metric names are protocol-free URLs as listed in the Supported Metrics page. - # For example, compute.googleapis.com/instance/disk/read_ops_count. - # @param [String] youngest - # End of the time interval (inclusive), which is expressed as an RFC 3339 - # timestamp. - # @param [Google::Apis::CloudmonitoringV2beta2::ListTimeseriesRequest] list_timeseries_request_object - # @param [String] aggregator - # The aggregation function that will reduce the data points in each window to a - # single point. This parameter is only valid for non-cumulative metrics with a - # value type of INT64 or DOUBLE. - # @param [Fixnum] count - # Maximum number of data points per page, which is used for pagination of - # results. - # @param [Array, String] labels - # A collection of labels for the matching time series, which are represented as: - # - # - key==value: key equals the value - # - key=~value: key regex matches the value - # - key!=value: key does not equal the value - # - key!~value: key regex does not match the value For example, to list all of - # the time series descriptors for the region us-central1, you could specify: - # label=cloud.googleapis.com%2Flocation=~us-central1.* - # @param [String] oldest - # Start of the time interval (exclusive), which is expressed as an RFC 3339 - # timestamp. If neither oldest nor timespan is specified, the default time - # interval will be (youngest - 4 hours, youngest] - # @param [String] page_token - # The pagination token, which is used to page through large result sets. Set - # this value to the value of the nextPageToken to retrieve the next page of - # results. - # @param [String] timespan - # Length of the time interval to query, which is an alternative way to declare - # the interval: (youngest - timespan, youngest]. The timespan and oldest - # parameters should not be used together. Units: - # - s: second - # - m: minute - # - h: hour - # - d: day - # - w: week Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d - # is not allowed; you should use 17d instead. - # If neither oldest nor timespan is specified, the default time interval will be - # (youngest - 4 hours, youngest]. - # @param [String] window - # The sampling window. At most one data point will be returned for each window - # in the requested time interval. This parameter is only valid for non- - # cumulative metric types. Units: - # - m: minute - # - h: hour - # - d: day - # - w: week Examples: 3m, 4w. Only one unit is allowed, for example: 2w3d is - # not allowed; you should use 17d instead. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # Overrides userIp if both are provided. - # @param [String] user_ip - # IP address of the site where the request originates. Use this if you want to - # enforce per-user limits. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudmonitoringV2beta2::ListTimeseriesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudmonitoringV2beta2::ListTimeseriesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_timeseries(project, metric, youngest, list_timeseries_request_object = nil, aggregator: nil, count: nil, labels: nil, oldest: nil, page_token: nil, timespan: nil, window: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}/timeseries/{metric}', options) - command.request_representation = Google::Apis::CloudmonitoringV2beta2::ListTimeseriesRequest::Representation - command.request_object = list_timeseries_request_object - command.response_representation = Google::Apis::CloudmonitoringV2beta2::ListTimeseriesResponse::Representation - command.response_class = Google::Apis::CloudmonitoringV2beta2::ListTimeseriesResponse - command.params['project'] = project unless project.nil? - command.params['metric'] = metric unless metric.nil? - command.query['aggregator'] = aggregator unless aggregator.nil? - command.query['count'] = count unless count.nil? - command.query['labels'] = labels unless labels.nil? - command.query['oldest'] = oldest unless oldest.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['timespan'] = timespan unless timespan.nil? - command.query['window'] = window unless window.nil? - command.query['youngest'] = youngest unless youngest.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Put data points to one or more time series for one or more metrics. If a time - # series does not exist, a new time series will be created. It is not allowed to - # write a time series point that is older than the existing youngest point of - # that time series. Points that are older than the existing youngest point of - # that time series will be discarded silently. Therefore, users should make sure - # that points of a time series are written sequentially in the order of their - # end time. - # @param [String] project - # The project ID. The value can be the numeric project ID or string-based - # project name. - # @param [Google::Apis::CloudmonitoringV2beta2::WriteTimeseriesRequest] write_timeseries_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # Overrides userIp if both are provided. - # @param [String] user_ip - # IP address of the site where the request originates. Use this if you want to - # enforce per-user limits. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudmonitoringV2beta2::WriteTimeseriesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudmonitoringV2beta2::WriteTimeseriesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def write_timeseries(project, write_timeseries_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, '{project}/timeseries:write', options) - command.request_representation = Google::Apis::CloudmonitoringV2beta2::WriteTimeseriesRequest::Representation - command.request_object = write_timeseries_request_object - command.response_representation = Google::Apis::CloudmonitoringV2beta2::WriteTimeseriesResponse::Representation - command.response_class = Google::Apis::CloudmonitoringV2beta2::WriteTimeseriesResponse - command.params['project'] = project unless project.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # List the descriptors of the time series that match the metric and labels - # values and that have data points in the interval. Large responses are - # paginated; use the nextPageToken returned in the response to request - # subsequent pages of results by setting the pageToken query parameter to the - # value of the nextPageToken. - # @param [String] project - # The project ID to which this time series belongs. The value can be the numeric - # project ID or string-based project name. - # @param [String] metric - # Metric names are protocol-free URLs as listed in the Supported Metrics page. - # For example, compute.googleapis.com/instance/disk/read_ops_count. - # @param [String] youngest - # End of the time interval (inclusive), which is expressed as an RFC 3339 - # timestamp. - # @param [Google::Apis::CloudmonitoringV2beta2::ListTimeseriesDescriptorsRequest] list_timeseries_descriptors_request_object - # @param [String] aggregator - # The aggregation function that will reduce the data points in each window to a - # single point. This parameter is only valid for non-cumulative metrics with a - # value type of INT64 or DOUBLE. - # @param [Fixnum] count - # Maximum number of time series descriptors per page. Used for pagination. If - # not specified, count = 100. - # @param [Array, String] labels - # A collection of labels for the matching time series, which are represented as: - # - # - key==value: key equals the value - # - key=~value: key regex matches the value - # - key!=value: key does not equal the value - # - key!~value: key regex does not match the value For example, to list all of - # the time series descriptors for the region us-central1, you could specify: - # label=cloud.googleapis.com%2Flocation=~us-central1.* - # @param [String] oldest - # Start of the time interval (exclusive), which is expressed as an RFC 3339 - # timestamp. If neither oldest nor timespan is specified, the default time - # interval will be (youngest - 4 hours, youngest] - # @param [String] page_token - # The pagination token, which is used to page through large result sets. Set - # this value to the value of the nextPageToken to retrieve the next page of - # results. - # @param [String] timespan - # Length of the time interval to query, which is an alternative way to declare - # the interval: (youngest - timespan, youngest]. The timespan and oldest - # parameters should not be used together. Units: - # - s: second - # - m: minute - # - h: hour - # - d: day - # - w: week Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d - # is not allowed; you should use 17d instead. - # If neither oldest nor timespan is specified, the default time interval will be - # (youngest - 4 hours, youngest]. - # @param [String] window - # The sampling window. At most one data point will be returned for each window - # in the requested time interval. This parameter is only valid for non- - # cumulative metric types. Units: - # - m: minute - # - h: hour - # - d: day - # - w: week Examples: 3m, 4w. Only one unit is allowed, for example: 2w3d is - # not allowed; you should use 17d instead. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # Overrides userIp if both are provided. - # @param [String] user_ip - # IP address of the site where the request originates. Use this if you want to - # enforce per-user limits. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::CloudmonitoringV2beta2::ListTimeseriesDescriptorsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::CloudmonitoringV2beta2::ListTimeseriesDescriptorsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_timeseries_descriptors(project, metric, youngest, list_timeseries_descriptors_request_object = nil, aggregator: nil, count: nil, labels: nil, oldest: nil, page_token: nil, timespan: nil, window: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, '{project}/timeseriesDescriptors/{metric}', options) - command.request_representation = Google::Apis::CloudmonitoringV2beta2::ListTimeseriesDescriptorsRequest::Representation - command.request_object = list_timeseries_descriptors_request_object - command.response_representation = Google::Apis::CloudmonitoringV2beta2::ListTimeseriesDescriptorsResponse::Representation - command.response_class = Google::Apis::CloudmonitoringV2beta2::ListTimeseriesDescriptorsResponse - command.params['project'] = project unless project.nil? - command.params['metric'] = metric unless metric.nil? - command.query['aggregator'] = aggregator unless aggregator.nil? - command.query['count'] = count unless count.nil? - command.query['labels'] = labels unless labels.nil? - command.query['oldest'] = oldest unless oldest.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['timespan'] = timespan unless timespan.nil? - command.query['window'] = window unless window.nil? - command.query['youngest'] = youngest unless youngest.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - end - end - end - end -end diff --git a/generated/google/apis/cloudtasks_v2beta2.rb b/generated/google/apis/cloudtasks_v2beta2.rb index 5b202085e..f2f6c9b67 100644 --- a/generated/google/apis/cloudtasks_v2beta2.rb +++ b/generated/google/apis/cloudtasks_v2beta2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/cloud-tasks/ module CloudtasksV2beta2 VERSION = 'V2beta2' - REVISION = '20171005' + REVISION = '20171123' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtasks_v2beta2/classes.rb b/generated/google/apis/cloudtasks_v2beta2/classes.rb index 1fe574962..3c50105f5 100644 --- a/generated/google/apis/cloudtasks_v2beta2/classes.rb +++ b/generated/google/apis/cloudtasks_v2beta2/classes.rb @@ -130,8 +130,6 @@ module Google # The app's request handler for the task's target URL must be able to handle # HTTP requests with this http_method, otherwise the task attempt will fail # with error code 405 (Method Not Allowed). See - # the Request-Line is not allowed for the resource identified by the - # Request-URI". See # [Writing a push task request handler](/appengine/docs/java/taskqueue/push/ # creating-handlers#writing_a_push_task_request_handler) # and the documentation for the request handlers in the language your app is @@ -211,7 +209,7 @@ module Google end end - # Deprecated. Use AppEngineTarget. + # Deprecated. Use AppEngineHttpTarget. class AppEngineQueueConfig include Google::Apis::Core::Hashable @@ -250,8 +248,8 @@ module Google class AppEngineRouting include Google::Apis::Core::Hashable - # Output only. - # The host that the task is sent to. For more information, see + # Output only. The host that the task is sent to. + # For more information, see # [How Requests are Routed](/appengine/docs/standard/python/how-requests-are- # routed). # The host is constructed as: @@ -410,8 +408,7 @@ module Google class AttemptStatus include Google::Apis::Core::Hashable - # Output only. - # The time that this attempt was dispatched. + # Output only. The time that this attempt was dispatched. # `dispatch_time` will be truncated to the nearest microsecond. # Corresponds to the JSON property `dispatchTime` # @return [String] @@ -460,15 +457,13 @@ module Google # @return [Google::Apis::CloudtasksV2beta2::Status] attr_accessor :response_status - # Output only. - # The time that this attempt response was received. + # Output only. The time that this attempt response was received. # `response_time` will be truncated to the nearest microsecond. # Corresponds to the JSON property `responseTime` # @return [String] attr_accessor :response_time - # Output only. - # The time that this attempt was scheduled. + # Output only. The time that this attempt was scheduled. # `schedule_time` will be truncated to the nearest microsecond. # Corresponds to the JSON property `scheduleTime` # @return [String] @@ -668,7 +663,6 @@ module Google # If the next_page_token is empty, there are no more results. # The page token is valid for only 2 hours. # Corresponds to the JSON property `nextPageToken` - # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :next_page_token @@ -698,7 +692,6 @@ module Google # ListTasksRequest.page_token. # If the next_page_token is empty, there are no more results. # Corresponds to the JSON property `nextPageToken` - # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :next_page_token @@ -850,9 +843,14 @@ module Google # @return [String] attr_accessor :payload - # A meta-data tag for this task. - # This value is used by CloudTasks.PullTasks calls when - # PullTasksRequest.filter is `tag=`. + # The task's tag. + # Tags allow similar tasks to be processed in a batch. If you label + # tasks with a tag, your task worker can pull tasks + # with the same tag using PullTasksRequest.filter. For example, + # if you want to aggregate the events associated with a specific + # user once a day, you could tag tasks with the user ID. + # The task's tag can only be set when the + # task is created. # The tag must be less than 500 bytes. # Corresponds to the JSON property `tag` # NOTE: Values are automatically base64 encoded/decoded in the client library. @@ -1049,7 +1047,7 @@ module Google # @return [Google::Apis::CloudtasksV2beta2::AppEngineHttpTarget] attr_accessor :app_engine_http_target - # Deprecated. Use AppEngineTarget. + # Deprecated. Use AppEngineHttpTarget. # Corresponds to the JSON property `appEngineQueueConfig` # @return [Google::Apis::CloudtasksV2beta2::AppEngineQueueConfig] attr_accessor :app_engine_queue_config @@ -1057,13 +1055,14 @@ module Google # The queue name. # The queue name must have the following format: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` - # * `PROJECT_ID` can contain uppercase and lowercase letters, - # numbers, hyphens, colons, and periods; that is, it must match - # the regular expression: `[a-zA-Z\\d-:\\.]+`. - # * `QUEUE_ID` can contain uppercase and lowercase letters, - # numbers, and hyphens; that is, it must match the regular - # expression: `[a-zA-Z\\d-]+`. The maximum length is 100 - # characters. + # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), + # hyphens (-), colons (:), or periods (.). + # * `LOCATION_ID` is the canonical ID for the queue's location. + # The list of available locations can be obtained by calling + # google.cloud.location.Locations.ListLocations. + # For more information, see https://cloud.google.com/about/locations/. + # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or + # hyphens (-). The maximum length is 100 characters. # Caller-specified and required in CreateQueueRequest, after which # it becomes output only. # Corresponds to the JSON property `name` @@ -1080,9 +1079,9 @@ module Google # @return [Google::Apis::CloudtasksV2beta2::PullTarget] attr_accessor :pull_target - # Output only. - # The last time this queue was purged. All tasks that were - # created before this time were purged. + # Output only. The last time this queue was purged. + # All tasks that were created before this time + # were purged. # A queue can be purged using CloudTasks.PurgeQueue, the # [App Engine Task Queue SDK, or the Cloud Console](/appengine/docs/standard/ # python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue) @@ -1093,16 +1092,6 @@ module Google # @return [String] attr_accessor :purge_time - # Output only. - # The state of the queue. - # `queue_state` can only be changed by called - # CloudTasks.PauseQueue, CloudTasks.ResumeQueue, or uploading - # [queue.yaml](/appengine/docs/python/config/queueref). - # CloudTasks.UpdateQueue cannot be used to change `queue_state`. - # Corresponds to the JSON property `queueState` - # @return [String] - attr_accessor :queue_state - # Rate limits. # This message determines the maximum rate that tasks can be dispatched by a # queue, regardless of whether the dispatch is a first task attempt or a retry. @@ -1116,6 +1105,15 @@ module Google # @return [Google::Apis::CloudtasksV2beta2::RetryConfig] attr_accessor :retry_config + # Output only. The state of the queue. + # `state` can only be changed by called + # CloudTasks.PauseQueue, CloudTasks.ResumeQueue, or uploading + # [queue.yaml](/appengine/docs/python/config/queueref). + # CloudTasks.UpdateQueue cannot be used to change `state`. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + def initialize(**args) update!(**args) end @@ -1128,9 +1126,9 @@ module Google @pull_queue_config = args[:pull_queue_config] if args.key?(:pull_queue_config) @pull_target = args[:pull_target] if args.key?(:pull_target) @purge_time = args[:purge_time] if args.key?(:purge_time) - @queue_state = args[:queue_state] if args.key?(:queue_state) @rate_limits = args[:rate_limits] if args.key?(:rate_limits) @retry_config = args[:retry_config] if args.key?(:retry_config) + @state = args[:state] if args.key?(:state) end end @@ -1140,12 +1138,12 @@ module Google class RateLimits include Google::Apis::Core::Hashable - # Output only. - # The max burst size limits how fast the queue is processed when - # many tasks are in the queue and the rate is high. This field - # allows the queue to have a high rate so processing starts shortly - # after a task is enqueued, but still limits resource usage when - # many tasks are enqueued in a short period of time. + # Output only. The max burst size. + # Max burst size limits how fast the queue is processed when many + # tasks are in the queue and the rate is high. This field allows + # the queue to have a high rate so processing starts shortly after + # a task is enqueued, but still limits resource usage when many + # tasks are enqueued in a short period of time. # * For App Engine queues, if # RateLimits.max_tasks_dispatched_per_second is 1, this # field is 10; otherwise this field is @@ -1182,6 +1180,8 @@ module Google # The maximum allowed value is 500. # * For App Engine queues, this field is 1 by default. # * For pull queues, this field is output only and always 10,000. + # In addition to the `max_tasks_dispatched_per_second` limit, a maximum of + # 10 QPS of CloudTasks.PullTasks requests are allowed per queue. # This field has the same meaning as # [rate in queue.yaml](/appengine/docs/standard/python/config/queueref#rate). # Corresponds to the JSON property `maxTasksDispatchedPerSecond` @@ -1207,10 +1207,10 @@ module Google # Required. # The desired new lease duration, starting from now. # The maximum lease duration is 1 week. - # `new_lease_duration` will be truncated to the nearest second. - # Corresponds to the JSON property `newLeaseDuration` + # `lease_duration` will be truncated to the nearest second. + # Corresponds to the JSON property `leaseDuration` # @return [String] - attr_accessor :new_lease_duration + attr_accessor :lease_duration # The response_view specifies which subset of the Task will be # returned. @@ -1241,7 +1241,7 @@ module Google # Update properties of this object def update!(**args) - @new_lease_duration = args[:new_lease_duration] if args.key?(:new_lease_duration) + @lease_duration = args[:lease_duration] if args.key?(:lease_duration) @response_view = args[:response_view] if args.key?(:response_view) @schedule_time = args[:schedule_time] if args.key?(:schedule_time) end @@ -1287,11 +1287,19 @@ module Google # @return [String] attr_accessor :max_backoff - # The time between retries increases exponentially `max_doublings` times. - # `max_doublings` is maximum number of times that the interval between failed - # task retries will be doubled before the interval increases linearly. - # After max_doublings intervals, the retry interval will be - # 2^(max_doublings - 1) * RetryConfig.min_backoff. + # The time between retries will double `max_doublings` times. + # A task's retry interval starts at RetryConfig.min_backoff, + # then doubles `max_doublings` times, then increases linearly, and + # finally retries retries at intervals of + # RetryConfig.max_backoff up to max_attempts times. + # For example, if RetryConfig.min_backoff is 10s, + # RetryConfig.max_backoff is 300s, and `max_doublings` is 3, + # then the a task will first be retried in 10s. The retry interval + # will double three times, and then increase linearly by 2^3 * 10s. + # Finally, the task will retry at intervals of + # RetryConfig.max_backoff until the task has been attempted + # `max_attempts` times. Thus, the requests will retry at 10s, 20s, + # 40s, 80s, 160s, 240s, 300s, 300s, .... # * For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget), # this field is 16 by default. # * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this field @@ -1546,8 +1554,7 @@ module Google # @return [Google::Apis::CloudtasksV2beta2::AppEngineTaskTarget] attr_accessor :app_engine_task_target - # Output only. - # The time that the task was created. + # Output only. The time that the task was created. # `create_time` will be truncated to the nearest second. # Corresponds to the JSON property `createTime` # @return [String] @@ -1556,17 +1563,16 @@ module Google # The task name. # The task name must have the following format: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` - # * `PROJECT_ID` can contain uppercase and lowercase letters, - # numbers, hyphens, colons, and periods; that is, it must match - # the regular expression: `[a-zA-Z\\d-:\\.]+`. - # * `QUEUE_ID` can contain uppercase and lowercase letters, - # numbers, and hyphens; that is, it must match the regular - # expression: `[a-zA-Z\\d-]+`. The maximum length is 100 - # characters. - # * `TASK_ID` contain uppercase and lowercase letters, numbers, - # underscores, and hyphens; that is, it must match the regular - # expression: `[a-zA-Z\\d_-]+`. The maximum length is 500 - # characters. + # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), + # hyphens (-), colons (:), or periods (.). + # * `LOCATION_ID` is the canonical ID for the task's location. + # The list of available locations can be obtained by calling + # google.cloud.location.Locations.ListLocations. + # For more information, see https://cloud.google.com/about/locations/. + # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or + # hyphens (-). The maximum length is 100 characters. + # * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), + # hyphens (-), or underscores (_). The maximum length is 500 characters. # Optionally caller-specified in CreateTaskRequest. # Corresponds to the JSON property `name` # @return [String] @@ -1601,9 +1607,8 @@ module Google # @return [Google::Apis::CloudtasksV2beta2::TaskStatus] attr_accessor :task_status - # Output only. - # The view specifies which subset of the Task has been - # returned. + # Output only. The view specifies which subset of the Task has + # been returned. # Corresponds to the JSON property `view` # @return [String] attr_accessor :view @@ -1630,15 +1635,14 @@ module Google class TaskStatus include Google::Apis::Core::Hashable - # Output only. - # The number of attempts dispatched. This count includes tasks which have - # been dispatched but haven't received a response. + # Output only. The number of attempts dispatched. + # This count includes tasks which have been dispatched but haven't + # received a response. # Corresponds to the JSON property `attemptDispatchCount` # @return [Fixnum] attr_accessor :attempt_dispatch_count - # Output only. - # The number of attempts which have received a response. + # Output only. The number of attempts which have received a response. # This field is not calculated for # [pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget). # Corresponds to the JSON property `attemptResponseCount` diff --git a/generated/google/apis/cloudtasks_v2beta2/representations.rb b/generated/google/apis/cloudtasks_v2beta2/representations.rb index cb5ac0af8..978b17d11 100644 --- a/generated/google/apis/cloudtasks_v2beta2/representations.rb +++ b/generated/google/apis/cloudtasks_v2beta2/representations.rb @@ -361,7 +361,7 @@ module Google class ListQueuesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, :base64 => true, as: 'nextPageToken' + property :next_page_token, as: 'nextPageToken' collection :queues, as: 'queues', class: Google::Apis::CloudtasksV2beta2::Queue, decorator: Google::Apis::CloudtasksV2beta2::Queue::Representation end @@ -370,7 +370,7 @@ module Google class ListTasksResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, :base64 => true, as: 'nextPageToken' + property :next_page_token, as: 'nextPageToken' collection :tasks, as: 'tasks', class: Google::Apis::CloudtasksV2beta2::Task, decorator: Google::Apis::CloudtasksV2beta2::Task::Representation end @@ -467,11 +467,11 @@ module Google property :pull_target, as: 'pullTarget', class: Google::Apis::CloudtasksV2beta2::PullTarget, decorator: Google::Apis::CloudtasksV2beta2::PullTarget::Representation property :purge_time, as: 'purgeTime' - property :queue_state, as: 'queueState' property :rate_limits, as: 'rateLimits', class: Google::Apis::CloudtasksV2beta2::RateLimits, decorator: Google::Apis::CloudtasksV2beta2::RateLimits::Representation property :retry_config, as: 'retryConfig', class: Google::Apis::CloudtasksV2beta2::RetryConfig, decorator: Google::Apis::CloudtasksV2beta2::RetryConfig::Representation + property :state, as: 'state' end end @@ -487,7 +487,7 @@ module Google class RenewLeaseRequest # @private class Representation < Google::Apis::Core::JsonRepresentation - property :new_lease_duration, as: 'newLeaseDuration' + property :lease_duration, as: 'leaseDuration' property :response_view, as: 'responseView' property :schedule_time, as: 'scheduleTime' end diff --git a/generated/google/apis/cloudtasks_v2beta2/service.rb b/generated/google/apis/cloudtasks_v2beta2/service.rb index bbf485b7d..60e18ba0c 100644 --- a/generated/google/apis/cloudtasks_v2beta2/service.rb +++ b/generated/google/apis/cloudtasks_v2beta2/service.rb @@ -118,11 +118,11 @@ module Google end # Creates a queue. - # WARNING: This method is only available to whitelisted - # users. Using this method carries some risk. Read + # WARNING: Using this method may have unintended side effects if you are + # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + # Read # [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) - # carefully and then sign up for - # [whitelist access to this method](https://goo.gl/Fe5mUy). + # carefully before using this method. # @param [String] parent # Required. # The location name in which the queue will be created. @@ -164,11 +164,11 @@ module Google # This command will delete the queue even if it has tasks in it. # Note: If you delete a queue, a queue with the same name can't be created # for 7 days. - # WARNING: This method is only available to whitelisted - # users. Using this method carries some risk. Read + # WARNING: Using this method may have unintended side effects if you are + # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + # Read # [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) - # carefully and then sign up for - # [whitelist access to this method](https://goo.gl/Fe5mUy). + # carefully before using this method. # @param [String] name # Required. # The queue name. For example: @@ -334,22 +334,23 @@ module Google # Updates a queue. # This method creates the queue if it does not exist and updates # the queue if it does exist. - # WARNING: This method is only available to whitelisted - # users. Using this method carries some risk. Read + # WARNING: Using this method may have unintended side effects if you are + # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. + # Read # [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) - # carefully and then sign up for - # [whitelist access to this method](https://goo.gl/Fe5mUy). + # carefully before using this method. # @param [String] name # The queue name. # The queue name must have the following format: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` - # * `PROJECT_ID` can contain uppercase and lowercase letters, - # numbers, hyphens, colons, and periods; that is, it must match - # the regular expression: `[a-zA-Z\\d-:\\.]+`. - # * `QUEUE_ID` can contain uppercase and lowercase letters, - # numbers, and hyphens; that is, it must match the regular - # expression: `[a-zA-Z\\d-]+`. The maximum length is 100 - # characters. + # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), + # hyphens (-), colons (:), or periods (.). + # * `LOCATION_ID` is the canonical ID for the queue's location. + # The list of available locations can be obtained by calling + # google.cloud.location.Locations.ListLocations. + # For more information, see https://cloud.google.com/about/locations/. + # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or + # hyphens (-). The maximum length is 100 characters. # Caller-specified and required in CreateQueueRequest, after which # it becomes output only. # @param [Google::Apis::CloudtasksV2beta2::Queue] queue_object @@ -391,13 +392,8 @@ module Google # tasks in the queue until it is resumed via # CloudTasks.ResumeQueue. Tasks can still be added when the # queue is paused. The state of the queue is stored in - # Queue.queue_state; if paused it will be set to - # Queue.QueueState.PAUSED. - # WARNING: This method is only available to whitelisted - # users. Using this method carries some risk. Read - # [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) - # carefully and then sign up for - # [whitelist access to this method](https://goo.gl/Fe5mUy). + # Queue.state; if paused it will be set to + # Queue.State.PAUSED. # @param [String] name # Required. # The queue name. For example: @@ -472,14 +468,9 @@ module Google # Resume a queue. # This method resumes a queue after it has been - # Queue.QueueState.PAUSED or Queue.QueueState.DISABLED. The state of - # a queue is stored in Queue.queue_state; after calling this method it - # will be set to Queue.QueueState.RUNNING. - # WARNING: This method is only available to whitelisted - # users. Using this method carries some risk. Read - # [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) - # carefully and then sign up for - # [whitelist access to this method](https://goo.gl/Fe5mUy). + # Queue.State.PAUSED or Queue.State.DISABLED. The state of + # a queue is stored in Queue.state; after calling this method it + # will be set to Queue.State.RUNNING. # WARNING: Resuming many high-QPS queues at the same time can # lead to target overloading. If you are resuming high-QPS # queues, follow the 500/50/5 pattern described in @@ -521,6 +512,8 @@ module Google # Sets the access control policy for a Queue. Replaces any existing # policy. + # Note: The Cloud Console does not check queue-level IAM permissions yet. + # Project-level permissions are required to use the Cloud Console. # Authorization requires the following [Google IAM](/iam) permission on the # specified resource parent: # * `cloudtasks.queues.setIamPolicy` @@ -606,6 +599,10 @@ module Google # PullTasksResponse. After the task is acknowledged, it will # not be returned by a later CloudTasks.PullTasks, # CloudTasks.GetTask, or CloudTasks.ListTasks. + # To acknowledge multiple tasks at the same time, use + # [HTTP batching](/storage/docs/json_api/v1/how-tos/batch) + # or the batching documentation for your client library, for example + # https://developers.google.com/api-client-library/python/guide/batch. # @param [String] name # Required. # The task name. For example: @@ -812,10 +809,10 @@ module Google # The queue name. For example: # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` # @param [String] order_by - # Sort order used for the query. The fields supported for sorting - # are Task.schedule_time and PullMessage.tag. All results will be - # returned in ascending order. The default ordering is by - # Task.schedule_time. + # Sort order used for the query. The only fields supported for sorting + # are `schedule_time` and `pull_message.tag`. All results will be + # returned in approximately ascending order. The default ordering is by + # `schedule_time`. # @param [Fixnum] page_size # Requested page size. Fewer tasks than requested might be returned. # The maximum page size is 1000. If unspecified, the page size will @@ -964,7 +961,7 @@ module Google # task after a fix has been made or to manually force a task to be # dispatched now. # When this method is called, Cloud Tasks will dispatch the task to its - # target, even if the queue is Queue.QueueState.PAUSED. + # target, even if the queue is Queue.State.PAUSED. # The dispatched task is returned. That is, the task that is returned # contains the Task.task_status after the task is dispatched but # before the task is received by its target. @@ -978,6 +975,7 @@ module Google # failed. google.rpc.Code.FAILED_PRECONDITION is returned when # CloudTasks.RunTask is called on task that is dispatched or # already running. + # CloudTasks.RunTask cannot be called on pull tasks. # @param [String] name # Required. # The task name. For example: diff --git a/generated/google/apis/cloudtrace_v1.rb b/generated/google/apis/cloudtrace_v1.rb index 8889a5ad8..5d8f4d881 100644 --- a/generated/google/apis/cloudtrace_v1.rb +++ b/generated/google/apis/cloudtrace_v1.rb @@ -20,15 +20,14 @@ module Google module Apis # Stackdriver Trace API # - # Send and retrieve trace data from Stackdriver Trace. Data is generated and - # available by default for all App Engine applications. Data from other - # applications can be written to Stackdriver Trace for display, reporting, and - # analysis. + # Sends application trace data to Stackdriver Trace for viewing. Trace data is + # collected for all App Engine applications by default. Trace data from other + # applications can be provided using this API. # # @see https://cloud.google.com/trace module CloudtraceV1 VERSION = 'V1' - REVISION = '20170927' + REVISION = '20171106' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtrace_v1/service.rb b/generated/google/apis/cloudtrace_v1/service.rb index 8ec5bfb0c..366c25c5e 100644 --- a/generated/google/apis/cloudtrace_v1/service.rb +++ b/generated/google/apis/cloudtrace_v1/service.rb @@ -22,10 +22,9 @@ module Google module CloudtraceV1 # Stackdriver Trace API # - # Send and retrieve trace data from Stackdriver Trace. Data is generated and - # available by default for all App Engine applications. Data from other - # applications can be written to Stackdriver Trace for display, reporting, and - # analysis. + # Sends application trace data to Stackdriver Trace for viewing. Trace data is + # collected for all App Engine applications by default. Trace data from other + # applications can be provided using this API. # # @example # require 'google/apis/cloudtrace_v1' diff --git a/generated/google/apis/cloudtrace_v2.rb b/generated/google/apis/cloudtrace_v2.rb index 2cb8d1a3b..e307c5193 100644 --- a/generated/google/apis/cloudtrace_v2.rb +++ b/generated/google/apis/cloudtrace_v2.rb @@ -20,15 +20,14 @@ module Google module Apis # Stackdriver Trace API # - # Send and retrieve trace data from Stackdriver Trace. Data is generated and - # available by default for all App Engine applications. Data from other - # applications can be written to Stackdriver Trace for display, reporting, and - # analysis. + # Sends application trace data to Stackdriver Trace for viewing. Trace data is + # collected for all App Engine applications by default. Trace data from other + # applications can be provided using this API. # # @see https://cloud.google.com/trace module CloudtraceV2 VERSION = 'V2' - REVISION = '20171003' + REVISION = '20171106' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudtrace_v2/classes.rb b/generated/google/apis/cloudtrace_v2/classes.rb index d48e21e8d..7da307a37 100644 --- a/generated/google/apis/cloudtrace_v2/classes.rb +++ b/generated/google/apis/cloudtrace_v2/classes.rb @@ -116,7 +116,8 @@ module Google class BatchWriteSpansRequest include Google::Apis::Core::Hashable - # A collection of spans. + # A list of new spans. The span names must not match existing + # spans, or the results are undefined. # Corresponds to the JSON property `spans` # @return [Array] attr_accessor :spans @@ -162,12 +163,12 @@ module Google # @return [Google::Apis::CloudtraceV2::Attributes] attr_accessor :attributes - # `SPAN_ID` identifies a span within a trace. + # The [SPAN_ID] for a span within a trace. # Corresponds to the JSON property `spanId` # @return [String] attr_accessor :span_id - # `TRACE_ID` identifies a trace within a project. + # The [TRACE_ID] for a trace within a project. # Corresponds to the JSON property `traceId` # @return [String] attr_accessor :trace_id @@ -223,11 +224,13 @@ module Google # The number of compressed bytes sent or received. If missing assumed to # be the same size as uncompressed. - # Corresponds to the JSON property `compressedSize` + # Corresponds to the JSON property `compressedSizeBytes` # @return [Fixnum] - attr_accessor :compressed_size + attr_accessor :compressed_size_bytes - # An identifier for the message, which must be unique in this span. + # An identifier for the MessageEvent's message that can be used to match + # SENT and RECEIVED MessageEvents. It is recommended to be unique within + # a Span. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id @@ -239,9 +242,9 @@ module Google attr_accessor :type # The number of uncompressed bytes sent or received. - # Corresponds to the JSON property `uncompressedSize` + # Corresponds to the JSON property `uncompressedSizeBytes` # @return [Fixnum] - attr_accessor :uncompressed_size + attr_accessor :uncompressed_size_bytes def initialize(**args) update!(**args) @@ -249,10 +252,10 @@ module Google # Update properties of this object def update!(**args) - @compressed_size = args[:compressed_size] if args.key?(:compressed_size) + @compressed_size_bytes = args[:compressed_size_bytes] if args.key?(:compressed_size_bytes) @id = args[:id] if args.key?(:id) @type = args[:type] if args.key?(:type) - @uncompressed_size = args[:uncompressed_size] if args.key?(:uncompressed_size) + @uncompressed_size_bytes = args[:uncompressed_size_bytes] if args.key?(:uncompressed_size_bytes) end end @@ -321,9 +324,10 @@ module Google # The resource name of the span in the following format: # projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique - # identifier for a trace within a project. - # [SPAN_ID] is a unique identifier for a span within a trace, - # assigned when the span is created. + # identifier for a trace within a project; + # it is a 32-character hexadecimal encoding of a 16-byte array. + # [SPAN_ID] is a unique identifier for a span within a trace; it + # is a 16-character hexadecimal encoding of an 8-byte array. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -334,9 +338,10 @@ module Google # @return [String] attr_accessor :parent_span_id - # A highly recommended but not required flag that identifies when a trace - # crosses a process boundary. True when the parent_span belongs to the - # same process as the current span. + # (Optional) Set this parameter to indicate whether this span is in + # the same process as its parent. If you do not set this parameter, + # Stackdriver Trace is unable to take advantage of this helpful + # information. # Corresponds to the JSON property `sameProcessAsParentSpan` # @return [Boolean] attr_accessor :same_process_as_parent_span @@ -693,12 +698,12 @@ module Google # @return [Fixnum] attr_accessor :truncated_byte_count - # The shortened string. For example, if the original string was 500 - # bytes long and the limit of the string was 128 bytes, then this - # value contains the first 128 bytes of the 500-byte string. Note that - # truncation always happens on the character boundary, to ensure that - # truncated string is still valid UTF8. In case of multi-byte characters, - # size of truncated string can be less than truncation limit. + # The shortened string. For example, if the original string is 500 + # bytes long and the limit of the string is 128 bytes, then + # `value` contains the first 128 bytes of the 500-byte string. + # Truncation always happens on a UTF8 character boundary. If there + # are multi-byte characters in the string, then the length of the + # shortened string might be less than the size limit. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value diff --git a/generated/google/apis/cloudtrace_v2/representations.rb b/generated/google/apis/cloudtrace_v2/representations.rb index b4cc99580..932d4699d 100644 --- a/generated/google/apis/cloudtrace_v2/representations.rb +++ b/generated/google/apis/cloudtrace_v2/representations.rb @@ -190,10 +190,10 @@ module Google class MessageEvent # @private class Representation < Google::Apis::Core::JsonRepresentation - property :compressed_size, :numeric_string => true, as: 'compressedSize' + property :compressed_size_bytes, :numeric_string => true, as: 'compressedSizeBytes' property :id, :numeric_string => true, as: 'id' property :type, as: 'type' - property :uncompressed_size, :numeric_string => true, as: 'uncompressedSize' + property :uncompressed_size_bytes, :numeric_string => true, as: 'uncompressedSizeBytes' end end diff --git a/generated/google/apis/cloudtrace_v2/service.rb b/generated/google/apis/cloudtrace_v2/service.rb index af2cf35a6..85238e7c8 100644 --- a/generated/google/apis/cloudtrace_v2/service.rb +++ b/generated/google/apis/cloudtrace_v2/service.rb @@ -22,10 +22,9 @@ module Google module CloudtraceV2 # Stackdriver Trace API # - # Send and retrieve trace data from Stackdriver Trace. Data is generated and - # available by default for all App Engine applications. Data from other - # applications can be written to Stackdriver Trace for display, reporting, and - # analysis. + # Sends application trace data to Stackdriver Trace for viewing. Trace data is + # collected for all App Engine applications by default. Trace data from other + # applications can be provided using this API. # # @example # require 'google/apis/cloudtrace_v2' @@ -50,14 +49,11 @@ module Google @batch_path = 'batch' end - # Sends new spans to Stackdriver Trace or updates existing traces. If the - # name of a trace that you send matches that of an existing trace, new spans - # are added to the existing trace. Attempt to update existing spans results - # undefined behavior. If the name does not match, a new trace is created - # with given set of spans. + # Sends new spans to new or existing traces. You cannot update + # existing spans. # @param [String] name - # Required. Name of the project where the spans belong. The format is - # `projects/PROJECT_ID`. + # Required. The name of the project where the spans belong. The format is + # `projects/[PROJECT_ID]`. # @param [Google::Apis::CloudtraceV2::BatchWriteSpansRequest] batch_write_spans_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -88,13 +84,14 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new Span. + # Creates a new span. # @param [String] name # The resource name of the span in the following format: # projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique - # identifier for a trace within a project. - # [SPAN_ID] is a unique identifier for a span within a trace, - # assigned when the span is created. + # identifier for a trace within a project; + # it is a 32-character hexadecimal encoding of a 16-byte array. + # [SPAN_ID] is a unique identifier for a span within a trace; it + # is a 16-character hexadecimal encoding of an 8-byte array. # @param [Google::Apis::CloudtraceV2::Span] span_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -114,7 +111,7 @@ module Google # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def create_project_trace_span(name, span_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'v2/{+name}', options) + command = make_simple_command(:post, 'v2/{+name}/spans', options) command.request_representation = Google::Apis::CloudtraceV2::Span::Representation command.request_object = span_object command.response_representation = Google::Apis::CloudtraceV2::Span::Representation diff --git a/generated/google/apis/compute_alpha.rb b/generated/google/apis/compute_alpha.rb index c7c9406f6..164721ad9 100644 --- a/generated/google/apis/compute_alpha.rb +++ b/generated/google/apis/compute_alpha.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/compute/docs/reference/latest/ module ComputeAlpha VERSION = 'Alpha' - REVISION = '20170919' + REVISION = '20171114' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/compute_alpha/classes.rb b/generated/google/apis/compute_alpha/classes.rb index 40d3acb88..828c850c9 100644 --- a/generated/google/apis/compute_alpha/classes.rb +++ b/generated/google/apis/compute_alpha/classes.rb @@ -1108,7 +1108,7 @@ module Google # Specifies a valid partial or full URL to an existing Persistent Disk resource. # When creating a new instance, one of initializeParams.sourceImage or disks. - # source is required. + # source is required except for local SSD. # If desired, you can also attach existing non-root persistent disks using this # property. This field is only applicable for persistent disks. # Note that for InstanceTemplate, specify the disk name, not the URL for the @@ -1186,7 +1186,7 @@ module Google attr_accessor :disk_type # The source image to create this disk. When creating a new instance, one of - # initializeParams.sourceImage or disks.source is required. + # initializeParams.sourceImage or disks.source is required except for local SSD. # To create a disk with one of the public operating system images, specify the # image by its family name. For example, specify family/debian-8 to use the # latest Debian 8 image: @@ -1880,7 +1880,7 @@ module Google # A filter string, compatible with a Stackdriver Monitoring filter string for # TimeSeries.list API call. This filter is used to select a specific TimeSeries # for the purpose of autoscaling and to determine whether the metric is - # exporting per-instance or global data. + # exporting per-instance or per-group data. # For the filter to be valid for autoscaling purposes, the following rules apply: # # - You can only use the AND operator for joining selectors. @@ -1895,7 +1895,8 @@ module Google # If the resource type is any other value, the autoscaler expects this metric to # contain values that apply to the entire autoscaled instance group and resource # label filtering can be performed to point autoscaler at the correct TimeSeries - # to scale upon. This is / called a global metric for the purpose of autoscaling. + # to scale upon. This is called a per-group metric for the purpose of + # autoscaling. # If not specified, the type defaults to gce_instance. # You should provide a filter that is selective enough to pick just one # TimeSeries for the autoscaled group or for each of the instances (if you are @@ -1907,19 +1908,17 @@ module Google attr_accessor :filter # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot - # have negative values and should be a utilization metric, which means that the - # number of virtual machines handling requests should increase or decrease - # proportionally to the metric. + # have negative values. # The metric must have a value type of INT64 or DOUBLE. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # If scaling is based on a global metric value that represents the total amount - # of work to be done or resource usage, set this value to an amount assigned for - # a single instance of the scaled group. Autoscaler will keep the number of - # instances proportional to the value of this metric, the metric itself should - # not change value due to group resizing. + # If scaling is based on a per-group metric value that represents the total + # amount of work to be done or resource usage, set this value to an amount + # assigned for a single instance of the scaled group. Autoscaler will keep the + # number of instances proportional to the value of this metric, the metric + # itself should not change value due to group resizing. # A good metric to use with the target is for example pubsub.googleapis.com/ # subscription/num_undelivered_messages or a custom metric exporting the total # number of requests coming to your instances. @@ -1931,7 +1930,8 @@ module Google attr_accessor :single_instance_assignment # The target value of the metric that autoscaler should maintain. This must be a - # positive value. + # positive value. A utilization metric scales number of virtual machines + # handling requests to increase or decrease proportionally to the metric. # For example, a good metric to use as a utilization_target is compute. # googleapis.com/instance/network/received_bytes_count. The autoscaler will work # to keep this value constant for each of the instances. @@ -3949,6 +3949,18 @@ module Google # @return [Google::Apis::ComputeAlpha::CustomerEncryptionKey] attr_accessor :disk_encryption_key + # A list of features to enable on the guest OS. Applicable for bootable disks + # only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, + # which allows each virtual CPU to have its own queue. For Windows disks, you + # can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0. + # 1621 or higher. Linux disks with kernel versions 3.17 and higher will support + # VIRTIO_SCSI_MULTIQUEUE. + # For newer Windows images, the server might also populate this property with + # the value WINDOWS to indicate that this is a Windows image. + # Corresponds to the JSON property `guestOsFeatures` + # @return [Array] + attr_accessor :guest_os_features + # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. # Corresponds to the JSON property `id` @@ -4142,6 +4154,7 @@ module Google @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @disk_encryption_key = args[:disk_encryption_key] if args.key?(:disk_encryption_key) + @guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @@ -5115,6 +5128,15 @@ module Google # @return [String] attr_accessor :direction + # Denotes whether the firewall rule is disabled, i.e not applied to the network + # it is associated with. When set to true, the firewall rule is not enforced and + # the network behaves as if it did not exist. If this is unspecified, the + # firewall rule will be enabled. + # Corresponds to the JSON property `disabled` + # @return [Boolean] + attr_accessor :disabled + alias_method :disabled?, :disabled + # This field denotes whether to enable logging for a particular firewall rule. # If logging is enabled, logs will be exported to the configured export # destination for all firewall logs in the network. Logs may be exported to @@ -5221,10 +5243,10 @@ module Google # @return [Array] attr_accessor :target_service_accounts - # A list of instance tags indicating sets of instances located in the network - # that may make network connections as specified in allowed[]. If no targetTags - # are specified, the firewall rule applies to all instances on the specified - # network. + # A list of tags that controls which instances the firewall rule applies to. If + # targetTags are specified, then the firewall rule applies only to instances in + # the VPC network that have one of those tags. If no targetTags are specified, + # the firewall rule applies to all instances on the specified network. # Corresponds to the JSON property `targetTags` # @return [Array] attr_accessor :target_tags @@ -5241,6 +5263,7 @@ module Google @description = args[:description] if args.key?(:description) @destination_ranges = args[:destination_ranges] if args.key?(:destination_ranges) @direction = args[:direction] if args.key?(:direction) + @disabled = args[:disabled] if args.key?(:disabled) @enable_logging = args[:enable_logging] if args.key?(:enable_logging) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @@ -5482,16 +5505,28 @@ module Google include Google::Apis::Core::Hashable # The IP address that this forwarding rule is serving on behalf of. - # For global forwarding rules, the address must be a global IP. For regional - # forwarding rules, the address must live in the same region as the forwarding - # rule. By default, this field is empty and an ephemeral IPv4 address from the - # same scope (global or regional) will be assigned. A regional forwarding rule - # supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. + # Addresses are restricted based on the forwarding rule's load balancing scheme ( + # EXTERNAL or INTERNAL) and scope (global or regional). + # When the load balancing scheme is EXTERNAL, for global forwarding rules, the + # address must be a global IP, and for regional forwarding rules, the address + # must live in the same region as the forwarding rule. If this field is empty, + # an ephemeral IPv4 address from the same scope (global or regional) will be + # assigned. A regional forwarding rule supports IPv4 only. A global forwarding + # rule supports either IPv4 or IPv6. # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP - # address belonging to the network/subnetwork configured for the forwarding rule. - # A reserved address cannot be used. If the field is empty, the IP address will - # be automatically allocated from the internal IP range of the subnetwork or - # network configured for this forwarding rule. + # address belonging to the network/subnet configured for the forwarding rule. By + # default, if this field is empty, an ephemeral internal IP address will be + # automatically allocated from the IP range of the subnet or network configured + # for this forwarding rule. + # An address can be specified either by a literal IP address or a URL reference + # to an existing Address resource. The following examples are all valid: + # - 100.1.2.3 + # - https://www.googleapis.com/compute/v1/projects/project/regions/region/ + # addresses/address + # - projects/project/regions/region/addresses/address + # - regions/region/addresses/address + # - global/addresses/address + # - address # Corresponds to the JSON property `IPAddress` # @return [String] attr_accessor :ip_address @@ -8537,6 +8572,11 @@ module Google # @return [String] attr_accessor :machine_type + # Maintenance policies applied to this instance. + # Corresponds to the JSON property `maintenancePolicies` + # @return [Array] + attr_accessor :maintenance_policies + # A metadata key/value entry. # Corresponds to the JSON property `metadata` # @return [Google::Apis::ComputeAlpha::Metadata] @@ -8634,6 +8674,7 @@ module Google @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @machine_type = args[:machine_type] if args.key?(:machine_type) + @maintenance_policies = args[:maintenance_policies] if args.key?(:maintenance_policies) @metadata = args[:metadata] if args.key?(:metadata) @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform) @name = args[:name] if args.key?(:name) @@ -9231,7 +9272,7 @@ module Google # Stateful configuration for this Instanced Group Manager # Corresponds to the JSON property `statefulPolicy` - # @return [Google::Apis::ComputeAlpha::InstanceGroupManagerStatefulPolicy] + # @return [Google::Apis::ComputeAlpha::StatefulPolicy] attr_accessor :stateful_policy # The URLs for all TargetPool resources to which instances in the instanceGroup @@ -9761,45 +9802,6 @@ module Google end end - # - class InstanceGroupManagerStatefulPolicy - include Google::Apis::Core::Hashable - - # Disks created on the instances that will be preserved on instance delete, - # resize down, etc. - # Corresponds to the JSON property `preservedDisks` - # @return [Array] - attr_accessor :preserved_disks - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @preserved_disks = args[:preserved_disks] if args.key?(:preserved_disks) - end - end - - # - class InstanceGroupManagerStatefulPolicyDiskPolicy - include Google::Apis::Core::Hashable - - # Device name of the disk to be preserved - # Corresponds to the JSON property `deviceName` - # @return [String] - attr_accessor :device_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @device_name = args[:device_name] if args.key?(:device_name) - end - end - # class InstanceGroupManagerUpdatePolicy include Google::Apis::Core::Hashable @@ -11512,7 +11514,7 @@ module Google end # Protocol definitions for Mixer API to support Interconnect. Next available tag: - # 23 + # 25 class Interconnect include Google::Apis::Core::Hashable @@ -11532,14 +11534,6 @@ module Google # @return [Array] attr_accessor :circuit_infos - # [Output Only] URL to retrieve the Letter Of Authority and Customer Facility - # Assignment (LOA-CFA) documentation relating to this Interconnect. This - # documentation authorizes the facility provider to connect to the specified - # crossconnect ports. - # Corresponds to the JSON property `connectionAuthorization` - # @return [String] - attr_accessor :connection_authorization - # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] @@ -11663,7 +11657,6 @@ module Google def update!(**args) @admin_enabled = args[:admin_enabled] if args.key?(:admin_enabled) @circuit_infos = args[:circuit_infos] if args.key?(:circuit_infos) - @connection_authorization = args[:connection_authorization] if args.key?(:connection_authorization) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @customer_name = args[:customer_name] if args.key?(:customer_name) @description = args[:description] if args.key?(:description) @@ -11687,7 +11680,7 @@ module Google end # Protocol definitions for Mixer API to support InterconnectAttachment. Next - # available tag: 18 + # available tag: 23 class InterconnectAttachment include Google::Apis::Core::Hashable @@ -12552,11 +12545,6 @@ module Google # @return [String] attr_accessor :region - # Scope key for the region of this location. - # Corresponds to the JSON property `regionKey` - # @return [String] - attr_accessor :region_key - def initialize(**args) update!(**args) end @@ -12566,7 +12554,6 @@ module Google @expected_rtt_ms = args[:expected_rtt_ms] if args.key?(:expected_rtt_ms) @location_presence = args[:location_presence] if args.key?(:location_presence) @region = args[:region] if args.key?(:region) - @region_key = args[:region_key] if args.key?(:region_key) end end @@ -19269,6 +19256,13 @@ module Google # @return [Google::Apis::ComputeAlpha::SecurityPolicyRuleMatcherConfig] attr_accessor :config + # Represents an expression text. Example: + # title: "User account presence" description: "Determines whether the request + # has a user account" expression: "size(request.user) > 0" + # Corresponds to the JSON property `expr` + # @return [Google::Apis::ComputeAlpha::Expr] + attr_accessor :expr + # CIDR IP address range. Only IPv4 is supported. # Corresponds to the JSON property `srcIpRanges` # @return [Array] @@ -19294,6 +19288,7 @@ module Google # Update properties of this object def update!(**args) @config = args[:config] if args.key?(:config) + @expr = args[:expr] if args.key?(:expr) @src_ip_ranges = args[:src_ip_ranges] if args.key?(:src_ip_ranges) @src_region_codes = args[:src_region_codes] if args.key?(:src_region_codes) @versioned_expr = args[:versioned_expr] if args.key?(:versioned_expr) @@ -20225,6 +20220,71 @@ module Google end end + # + class StatefulPolicy + include Google::Apis::Core::Hashable + + # Disks created on the instances that will be preserved on instance delete, + # resize down, etc. DEPRECATED in favor of preservedResources.disks field. + # Corresponds to the JSON property `preservedDisks` + # @return [Array] + attr_accessor :preserved_disks + + # Configuration of all preserved resources. + # Corresponds to the JSON property `preservedResources` + # @return [Google::Apis::ComputeAlpha::StatefulPolicyPreservedResources] + attr_accessor :preserved_resources + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @preserved_disks = args[:preserved_disks] if args.key?(:preserved_disks) + @preserved_resources = args[:preserved_resources] if args.key?(:preserved_resources) + end + end + + # + class StatefulPolicyPreservedDisk + include Google::Apis::Core::Hashable + + # Device name of the disk to be preserved + # Corresponds to the JSON property `deviceName` + # @return [String] + attr_accessor :device_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @device_name = args[:device_name] if args.key?(:device_name) + end + end + + # Configuration of all preserved resources. + class StatefulPolicyPreservedResources + include Google::Apis::Core::Hashable + + # Disks created on the instances that will be preserved on instance delete, + # resize down, etc. + # Corresponds to the JSON property `disks` + # @return [Array] + attr_accessor :disks + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @disks = args[:disks] if args.key?(:disks) + end + end + # A Subnetwork resource. class Subnetwork include Google::Apis::Core::Hashable diff --git a/generated/google/apis/compute_alpha/representations.rb b/generated/google/apis/compute_alpha/representations.rb index 610376616..6f11e4100 100644 --- a/generated/google/apis/compute_alpha/representations.rb +++ b/generated/google/apis/compute_alpha/representations.rb @@ -1216,18 +1216,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class InstanceGroupManagerStatefulPolicy - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InstanceGroupManagerStatefulPolicyDiskPolicy - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class InstanceGroupManagerUpdatePolicy class Representation < Google::Apis::Core::JsonRepresentation; end @@ -2794,6 +2782,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class StatefulPolicy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class StatefulPolicyPreservedDisk + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class StatefulPolicyPreservedResources + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Subnetwork class Representation < Google::Apis::Core::JsonRepresentation; end @@ -4417,6 +4423,8 @@ module Google property :description, as: 'description' property :disk_encryption_key, as: 'diskEncryptionKey', class: Google::Apis::ComputeAlpha::CustomerEncryptionKey, decorator: Google::Apis::ComputeAlpha::CustomerEncryptionKey::Representation + collection :guest_os_features, as: 'guestOsFeatures', class: Google::Apis::ComputeAlpha::GuestOsFeature, decorator: Google::Apis::ComputeAlpha::GuestOsFeature::Representation + property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :label_fingerprint, :base64 => true, as: 'labelFingerprint' @@ -4710,6 +4718,7 @@ module Google property :description, as: 'description' collection :destination_ranges, as: 'destinationRanges' property :direction, as: 'direction' + property :disabled, as: 'disabled' property :enable_logging, as: 'enableLogging' property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' @@ -5496,6 +5505,7 @@ module Google property :label_fingerprint, :base64 => true, as: 'labelFingerprint' hash :labels, as: 'labels' property :machine_type, as: 'machineType' + collection :maintenance_policies, as: 'maintenancePolicies' property :metadata, as: 'metadata', class: Google::Apis::ComputeAlpha::Metadata, decorator: Google::Apis::ComputeAlpha::Metadata::Representation property :min_cpu_platform, as: 'minCpuPlatform' @@ -5660,7 +5670,7 @@ module Google property :region, as: 'region' property :self_link, as: 'selfLink' property :service_account, as: 'serviceAccount' - property :stateful_policy, as: 'statefulPolicy', class: Google::Apis::ComputeAlpha::InstanceGroupManagerStatefulPolicy, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerStatefulPolicy::Representation + property :stateful_policy, as: 'statefulPolicy', class: Google::Apis::ComputeAlpha::StatefulPolicy, decorator: Google::Apis::ComputeAlpha::StatefulPolicy::Representation collection :target_pools, as: 'targetPools' property :target_size, as: 'targetSize' @@ -5784,21 +5794,6 @@ module Google end end - class InstanceGroupManagerStatefulPolicy - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :preserved_disks, as: 'preservedDisks', class: Google::Apis::ComputeAlpha::InstanceGroupManagerStatefulPolicyDiskPolicy, decorator: Google::Apis::ComputeAlpha::InstanceGroupManagerStatefulPolicyDiskPolicy::Representation - - end - end - - class InstanceGroupManagerStatefulPolicyDiskPolicy - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :device_name, as: 'deviceName' - end - end - class InstanceGroupManagerUpdatePolicy # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -6302,7 +6297,6 @@ module Google property :admin_enabled, as: 'adminEnabled' collection :circuit_infos, as: 'circuitInfos', class: Google::Apis::ComputeAlpha::InterconnectCircuitInfo, decorator: Google::Apis::ComputeAlpha::InterconnectCircuitInfo::Representation - property :connection_authorization, as: 'connectionAuthorization' property :creation_timestamp, as: 'creationTimestamp' property :customer_name, as: 'customerName' property :description, as: 'description' @@ -6546,7 +6540,6 @@ module Google property :expected_rtt_ms, :numeric_string => true, as: 'expectedRttMs' property :location_presence, as: 'locationPresence' property :region, as: 'region' - property :region_key, as: 'regionKey' end end @@ -8312,6 +8305,8 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :config, as: 'config', class: Google::Apis::ComputeAlpha::SecurityPolicyRuleMatcherConfig, decorator: Google::Apis::ComputeAlpha::SecurityPolicyRuleMatcherConfig::Representation + property :expr, as: 'expr', class: Google::Apis::ComputeAlpha::Expr, decorator: Google::Apis::ComputeAlpha::Expr::Representation + collection :src_ip_ranges, as: 'srcIpRanges' collection :src_region_codes, as: 'srcRegionCodes' property :versioned_expr, as: 'versionedExpr' @@ -8547,6 +8542,31 @@ module Google end end + class StatefulPolicy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :preserved_disks, as: 'preservedDisks', class: Google::Apis::ComputeAlpha::StatefulPolicyPreservedDisk, decorator: Google::Apis::ComputeAlpha::StatefulPolicyPreservedDisk::Representation + + property :preserved_resources, as: 'preservedResources', class: Google::Apis::ComputeAlpha::StatefulPolicyPreservedResources, decorator: Google::Apis::ComputeAlpha::StatefulPolicyPreservedResources::Representation + + end + end + + class StatefulPolicyPreservedDisk + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :device_name, as: 'deviceName' + end + end + + class StatefulPolicyPreservedResources + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :disks, as: 'disks', class: Google::Apis::ComputeAlpha::StatefulPolicyPreservedDisk, decorator: Google::Apis::ComputeAlpha::StatefulPolicyPreservedDisk::Representation + + end + end + class Subnetwork # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/compute_alpha/service.rb b/generated/google/apis/compute_alpha/service.rb index 7a7c46592..04057fb80 100644 --- a/generated/google/apis/compute_alpha/service.rb +++ b/generated/google/apis/compute_alpha/service.rb @@ -10945,11 +10945,10 @@ module Google end # Stops a running instance, shutting it down cleanly, and allows you to restart - # the instance at a later time. Stopped instances do not incur per-minute, - # virtual machine usage charges while they are stopped, but any resources that - # the virtual machine is using, such as persistent disks and static IP addresses, - # will continue to be charged until they are deleted. For more information, see - # Stopping an instance. + # the instance at a later time. Stopped instances do not incur VM usage charges + # while they are stopped. However, resources that the VM is using, such as + # persistent disks and static IP addresses, will continue to be charged until + # they are deleted. For more information, see Stopping an instance. # @param [String] project # Project ID for this request. # @param [String] zone @@ -18871,6 +18870,47 @@ module Google execute_or_queue_command(command, &block) end + # Inserts a rule into a security policy. + # @param [String] project + # Project ID for this request. + # @param [String] security_policy + # Name of the security policy to update. + # @param [Google::Apis::ComputeAlpha::SecurityPolicyRule] security_policy_rule_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def add_security_policy_rule(project, security_policy, security_policy_rule_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/global/securityPolicies/{securityPolicy}/addRule', options) + command.request_representation = Google::Apis::ComputeAlpha::SecurityPolicyRule::Representation + command.request_object = security_policy_rule_object + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Deletes the specified policy. # @param [String] project # Project ID for this request. @@ -18959,6 +18999,47 @@ module Google execute_or_queue_command(command, &block) end + # Gets a rule at the specified priority. + # @param [String] project + # Project ID for this request. + # @param [String] security_policy + # Name of the security policy to which the queried rule belongs. + # @param [Fixnum] priority + # The priority of the rule to get from the security policy. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::SecurityPolicyRule] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::SecurityPolicyRule] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_security_policy_rule(project, security_policy, priority: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/global/securityPolicies/{securityPolicy}/getRule', options) + command.response_representation = Google::Apis::ComputeAlpha::SecurityPolicyRule::Representation + command.response_class = Google::Apis::ComputeAlpha::SecurityPolicyRule + command.params['project'] = project unless project.nil? + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['priority'] = priority unless priority.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Creates a new policy in the specified project using the data included in the # request. # @param [String] project @@ -19139,6 +19220,91 @@ module Google execute_or_queue_command(command, &block) end + # Patches a rule at the specified priority. + # @param [String] project + # Project ID for this request. + # @param [String] security_policy + # Name of the security policy to update. + # @param [Google::Apis::ComputeAlpha::SecurityPolicyRule] security_policy_rule_object + # @param [Fixnum] priority + # The priority of the rule to patch. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_security_policy_rule(project, security_policy, security_policy_rule_object = nil, priority: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/global/securityPolicies/{securityPolicy}/patchRule', options) + command.request_representation = Google::Apis::ComputeAlpha::SecurityPolicyRule::Representation + command.request_object = security_policy_rule_object + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['priority'] = priority unless priority.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a rule at the specified priority. + # @param [String] project + # Project ID for this request. + # @param [String] security_policy + # Name of the security policy to update. + # @param [Fixnum] priority + # The priority of the rule to remove from the security policy. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeAlpha::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeAlpha::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def remove_security_policy_rule(project, security_policy, priority: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/global/securityPolicies/{securityPolicy}/removeRule', options) + command.response_representation = Google::Apis::ComputeAlpha::Operation::Representation + command.response_class = Google::Apis::ComputeAlpha::Operation + command.params['project'] = project unless project.nil? + command.params['securityPolicy'] = security_policy unless security_policy.nil? + command.query['priority'] = priority unless priority.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Returns permissions that a caller has on the specified resource. # @param [String] project # Project ID for this request. diff --git a/generated/google/apis/compute_beta.rb b/generated/google/apis/compute_beta.rb index 2d3defd76..6b0cdbeaa 100644 --- a/generated/google/apis/compute_beta.rb +++ b/generated/google/apis/compute_beta.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/compute/docs/reference/latest/ module ComputeBeta VERSION = 'Beta' - REVISION = '20170919' + REVISION = '20171114' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/compute_beta/classes.rb b/generated/google/apis/compute_beta/classes.rb index 3f06aa3cf..a012b6ba2 100644 --- a/generated/google/apis/compute_beta/classes.rb +++ b/generated/google/apis/compute_beta/classes.rb @@ -1068,7 +1068,7 @@ module Google # Specifies a valid partial or full URL to an existing Persistent Disk resource. # When creating a new instance, one of initializeParams.sourceImage or disks. - # source is required. + # source is required except for local SSD. # If desired, you can also attach existing non-root persistent disks using this # property. This field is only applicable for persistent disks. # Note that for InstanceTemplate, specify the disk name, not the URL for the @@ -1145,7 +1145,7 @@ module Google attr_accessor :disk_type # The source image to create this disk. When creating a new instance, one of - # initializeParams.sourceImage or disks.source is required. + # initializeParams.sourceImage or disks.source is required except for local SSD. # To create a disk with one of the public operating system images, specify the # image by its family name. For example, specify family/debian-8 to use the # latest Debian 8 image: @@ -1827,7 +1827,7 @@ module Google # A filter string, compatible with a Stackdriver Monitoring filter string for # TimeSeries.list API call. This filter is used to select a specific TimeSeries # for the purpose of autoscaling and to determine whether the metric is - # exporting per-instance or global data. + # exporting per-instance or per-group data. # For the filter to be valid for autoscaling purposes, the following rules apply: # # - You can only use the AND operator for joining selectors. @@ -1842,7 +1842,8 @@ module Google # If the resource type is any other value, the autoscaler expects this metric to # contain values that apply to the entire autoscaled instance group and resource # label filtering can be performed to point autoscaler at the correct TimeSeries - # to scale upon. This is / called a global metric for the purpose of autoscaling. + # to scale upon. This is called a per-group metric for the purpose of + # autoscaling. # If not specified, the type defaults to gce_instance. # You should provide a filter that is selective enough to pick just one # TimeSeries for the autoscaled group or for each of the instances (if you are @@ -1854,19 +1855,17 @@ module Google attr_accessor :filter # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot - # have negative values and should be a utilization metric, which means that the - # number of virtual machines handling requests should increase or decrease - # proportionally to the metric. + # have negative values. # The metric must have a value type of INT64 or DOUBLE. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # If scaling is based on a global metric value that represents the total amount - # of work to be done or resource usage, set this value to an amount assigned for - # a single instance of the scaled group. Autoscaler will keep the number of - # instances proportional to the value of this metric, the metric itself should - # not change value due to group resizing. + # If scaling is based on a per-group metric value that represents the total + # amount of work to be done or resource usage, set this value to an amount + # assigned for a single instance of the scaled group. Autoscaler will keep the + # number of instances proportional to the value of this metric, the metric + # itself should not change value due to group resizing. # A good metric to use with the target is for example pubsub.googleapis.com/ # subscription/num_undelivered_messages or a custom metric exporting the total # number of requests coming to your instances. @@ -1878,7 +1877,8 @@ module Google attr_accessor :single_instance_assignment # The target value of the metric that autoscaler should maintain. This must be a - # positive value. + # positive value. A utilization metric scales number of virtual machines + # handling requests to increase or decrease proportionally to the metric. # For example, a good metric to use as a utilization_target is compute. # googleapis.com/instance/network/received_bytes_count. The autoscaler will work # to keep this value constant for each of the instances. @@ -4780,10 +4780,10 @@ module Google # @return [Array] attr_accessor :target_service_accounts - # A list of instance tags indicating sets of instances located in the network - # that may make network connections as specified in allowed[]. If no targetTags - # are specified, the firewall rule applies to all instances on the specified - # network. + # A list of tags that controls which instances the firewall rule applies to. If + # targetTags are specified, then the firewall rule applies only to instances in + # the VPC network that have one of those tags. If no targetTags are specified, + # the firewall rule applies to all instances on the specified network. # Corresponds to the JSON property `targetTags` # @return [Array] attr_accessor :target_tags @@ -5040,16 +5040,28 @@ module Google include Google::Apis::Core::Hashable # The IP address that this forwarding rule is serving on behalf of. - # For global forwarding rules, the address must be a global IP. For regional - # forwarding rules, the address must live in the same region as the forwarding - # rule. By default, this field is empty and an ephemeral IPv4 address from the - # same scope (global or regional) will be assigned. A regional forwarding rule - # supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. + # Addresses are restricted based on the forwarding rule's load balancing scheme ( + # EXTERNAL or INTERNAL) and scope (global or regional). + # When the load balancing scheme is EXTERNAL, for global forwarding rules, the + # address must be a global IP, and for regional forwarding rules, the address + # must live in the same region as the forwarding rule. If this field is empty, + # an ephemeral IPv4 address from the same scope (global or regional) will be + # assigned. A regional forwarding rule supports IPv4 only. A global forwarding + # rule supports either IPv4 or IPv6. # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP - # address belonging to the network/subnetwork configured for the forwarding rule. - # A reserved address cannot be used. If the field is empty, the IP address will - # be automatically allocated from the internal IP range of the subnetwork or - # network configured for this forwarding rule. + # address belonging to the network/subnet configured for the forwarding rule. By + # default, if this field is empty, an ephemeral internal IP address will be + # automatically allocated from the IP range of the subnet or network configured + # for this forwarding rule. + # An address can be specified either by a literal IP address or a URL reference + # to an existing Address resource. The following examples are all valid: + # - 100.1.2.3 + # - https://www.googleapis.com/compute/v1/projects/project/regions/region/ + # addresses/address + # - projects/project/regions/region/addresses/address + # - regions/region/addresses/address + # - global/addresses/address + # - address # Corresponds to the JSON property `IPAddress` # @return [String] attr_accessor :ip_address @@ -6904,6 +6916,12 @@ module Google # @return [String] attr_accessor :creation_timestamp + # Whether the resource should be protected against deletion. + # Corresponds to the JSON property `deletionProtection` + # @return [Boolean] + attr_accessor :deletion_protection + alias_method :deletion_protection?, :deletion_protection + # An optional description of this resource. Provide this property when you # create the resource. # Corresponds to the JSON property `description` @@ -7052,6 +7070,7 @@ module Google @can_ip_forward = args[:can_ip_forward] if args.key?(:can_ip_forward) @cpu_platform = args[:cpu_platform] if args.key?(:cpu_platform) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) + @deletion_protection = args[:deletion_protection] if args.key?(:deletion_protection) @description = args[:description] if args.key?(:description) @disks = args[:disks] if args.key?(:disks) @guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators) @@ -9622,7 +9641,7 @@ module Google end # Protocol definitions for Mixer API to support Interconnect. Next available tag: - # 23 + # 25 class Interconnect include Google::Apis::Core::Hashable @@ -9642,14 +9661,6 @@ module Google # @return [Array] attr_accessor :circuit_infos - # [Output Only] URL to retrieve the Letter Of Authority and Customer Facility - # Assignment (LOA-CFA) documentation relating to this Interconnect. This - # documentation authorizes the facility provider to connect to the specified - # crossconnect ports. - # Corresponds to the JSON property `connectionAuthorization` - # @return [String] - attr_accessor :connection_authorization - # [Output Only] Creation timestamp in RFC3339 text format. # Corresponds to the JSON property `creationTimestamp` # @return [String] @@ -9773,7 +9784,6 @@ module Google def update!(**args) @admin_enabled = args[:admin_enabled] if args.key?(:admin_enabled) @circuit_infos = args[:circuit_infos] if args.key?(:circuit_infos) - @connection_authorization = args[:connection_authorization] if args.key?(:connection_authorization) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @customer_name = args[:customer_name] if args.key?(:customer_name) @description = args[:description] if args.key?(:description) @@ -9797,7 +9807,7 @@ module Google end # Protocol definitions for Mixer API to support InterconnectAttachment. Next - # available tag: 18 + # available tag: 23 class InterconnectAttachment include Google::Apis::Core::Hashable @@ -10662,11 +10672,6 @@ module Google # @return [String] attr_accessor :region - # Scope key for the region of this location. - # Corresponds to the JSON property `regionKey` - # @return [String] - attr_accessor :region_key - def initialize(**args) update!(**args) end @@ -10676,7 +10681,6 @@ module Google @expected_rtt_ms = args[:expected_rtt_ms] if args.key?(:expected_rtt_ms) @location_presence = args[:location_presence] if args.key?(:location_presence) @region = args[:region] if args.key?(:region) - @region_key = args[:region_key] if args.key?(:region_key) end end diff --git a/generated/google/apis/compute_beta/representations.rb b/generated/google/apis/compute_beta/representations.rb index df1d8ec9c..5a2ddfac2 100644 --- a/generated/google/apis/compute_beta/representations.rb +++ b/generated/google/apis/compute_beta/representations.rb @@ -4477,6 +4477,7 @@ module Google property :can_ip_forward, as: 'canIpForward' property :cpu_platform, as: 'cpuPlatform' property :creation_timestamp, as: 'creationTimestamp' + property :deletion_protection, as: 'deletionProtection' property :description, as: 'description' collection :disks, as: 'disks', class: Google::Apis::ComputeBeta::AttachedDisk, decorator: Google::Apis::ComputeBeta::AttachedDisk::Representation @@ -5200,7 +5201,6 @@ module Google property :admin_enabled, as: 'adminEnabled' collection :circuit_infos, as: 'circuitInfos', class: Google::Apis::ComputeBeta::InterconnectCircuitInfo, decorator: Google::Apis::ComputeBeta::InterconnectCircuitInfo::Representation - property :connection_authorization, as: 'connectionAuthorization' property :creation_timestamp, as: 'creationTimestamp' property :customer_name, as: 'customerName' property :description, as: 'description' @@ -5444,7 +5444,6 @@ module Google property :expected_rtt_ms, :numeric_string => true, as: 'expectedRttMs' property :location_presence, as: 'locationPresence' property :region, as: 'region' - property :region_key, as: 'regionKey' end end diff --git a/generated/google/apis/compute_beta/service.rb b/generated/google/apis/compute_beta/service.rb index 5b5a9ede2..5bb6a9879 100644 --- a/generated/google/apis/compute_beta/service.rb +++ b/generated/google/apis/compute_beta/service.rb @@ -8563,6 +8563,62 @@ module Google execute_or_queue_command(command, &block) end + # Sets deletion protection on the instance. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] resource + # Name of the resource for this request. + # @param [Boolean] deletion_protection + # Whether the resource should be protected against deletion. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeBeta::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeBeta::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_instance_deletion_protection(project, zone, resource, deletion_protection: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/zones/{zone}/instances/{resource}/setDeletionProtection', options) + command.response_representation = Google::Apis::ComputeBeta::Operation::Representation + command.response_class = Google::Apis::ComputeBeta::Operation + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['resource'] = resource unless resource.nil? + command.query['deletionProtection'] = deletion_protection unless deletion_protection.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Sets the auto-delete flag for a disk attached to an instance. # @param [String] project # Project ID for this request. @@ -9188,11 +9244,10 @@ module Google end # Stops a running instance, shutting it down cleanly, and allows you to restart - # the instance at a later time. Stopped instances do not incur per-minute, - # virtual machine usage charges while they are stopped, but any resources that - # the virtual machine is using, such as persistent disks and static IP addresses, - # will continue to be charged until they are deleted. For more information, see - # Stopping an instance. + # the instance at a later time. Stopped instances do not incur VM usage charges + # while they are stopped. However, resources that the VM is using, such as + # persistent disks and static IP addresses, will continue to be charged until + # they are deleted. For more information, see Stopping an instance. # @param [String] project # Project ID for this request. # @param [String] zone diff --git a/generated/google/apis/compute_v1.rb b/generated/google/apis/compute_v1.rb index c9808b014..ffac20a4a 100644 --- a/generated/google/apis/compute_v1.rb +++ b/generated/google/apis/compute_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/compute/docs/reference/latest/ module ComputeV1 VERSION = 'V1' - REVISION = '20170919' + REVISION = '20171114' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/compute_v1/classes.rb b/generated/google/apis/compute_v1/classes.rb index 9960745af..73c3d1786 100644 --- a/generated/google/apis/compute_v1/classes.rb +++ b/generated/google/apis/compute_v1/classes.rb @@ -1033,7 +1033,7 @@ module Google # Specifies a valid partial or full URL to an existing Persistent Disk resource. # When creating a new instance, one of initializeParams.sourceImage or disks. - # source is required. + # source is required except for local SSD. # If desired, you can also attach existing non-root persistent disks using this # property. This field is only applicable for persistent disks. # Note that for InstanceTemplate, specify the disk name, not the URL for the @@ -1105,7 +1105,7 @@ module Google attr_accessor :disk_type # The source image to create this disk. When creating a new instance, one of - # initializeParams.sourceImage or disks.source is required. + # initializeParams.sourceImage or disks.source is required except for local SSD. # To create a disk with one of the public operating system images, specify the # image by its family name. For example, specify family/debian-8 to use the # latest Debian 8 image: @@ -1686,16 +1686,15 @@ module Google include Google::Apis::Core::Hashable # The identifier (type) of the Stackdriver Monitoring metric. The metric cannot - # have negative values and should be a utilization metric, which means that the - # number of virtual machines handling requests should increase or decrease - # proportionally to the metric. + # have negative values. # The metric must have a value type of INT64 or DOUBLE. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric # The target value of the metric that autoscaler should maintain. This must be a - # positive value. + # positive value. A utilization metric scales number of virtual machines + # handling requests to increase or decrease proportionally to the metric. # For example, a good metric to use as a utilization_target is compute. # googleapis.com/instance/network/received_bytes_count. The autoscaler will work # to keep this value constant for each of the instances. @@ -4350,6 +4349,21 @@ module Google # @return [Array] attr_accessor :source_ranges + # If source service accounts are specified, the firewall will apply only to + # traffic originating from an instance with a service account in this list. + # Source service accounts cannot be used to control traffic to an instance's + # external IP address because service accounts are associated with an instance, + # not an IP address. sourceRanges can be set at the same time as + # sourceServiceAccounts. If both are set, the firewall will apply to traffic + # that has source IP address within sourceRanges OR the source IP belongs to an + # instance with service account listed in sourceServiceAccount. The connection + # does not need to match both properties for the firewall to apply. + # sourceServiceAccounts cannot be used at the same time as sourceTags or + # targetTags. + # Corresponds to the JSON property `sourceServiceAccounts` + # @return [Array] + attr_accessor :source_service_accounts + # If source tags are specified, the firewall rule applies only to traffic with # source IPs that match the primary network interfaces of VM instances that have # the tag and are in the same VPC network. Source tags cannot be used to control @@ -4364,10 +4378,19 @@ module Google # @return [Array] attr_accessor :source_tags - # A list of instance tags indicating sets of instances located in the network - # that may make network connections as specified in allowed[]. If no targetTags - # are specified, the firewall rule applies to all instances on the specified - # network. + # A list of service accounts indicating sets of instances located in the network + # that may make network connections as specified in allowed[]. + # targetServiceAccounts cannot be used at the same time as targetTags or + # sourceTags. If neither targetServiceAccounts nor targetTags are specified, the + # firewall rule applies to all instances on the specified network. + # Corresponds to the JSON property `targetServiceAccounts` + # @return [Array] + attr_accessor :target_service_accounts + + # A list of tags that controls which instances the firewall rule applies to. If + # targetTags are specified, then the firewall rule applies only to instances in + # the VPC network that have one of those tags. If no targetTags are specified, + # the firewall rule applies to all instances on the specified network. # Corresponds to the JSON property `targetTags` # @return [Array] attr_accessor :target_tags @@ -4391,7 +4414,9 @@ module Google @priority = args[:priority] if args.key?(:priority) @self_link = args[:self_link] if args.key?(:self_link) @source_ranges = args[:source_ranges] if args.key?(:source_ranges) + @source_service_accounts = args[:source_service_accounts] if args.key?(:source_service_accounts) @source_tags = args[:source_tags] if args.key?(:source_tags) + @target_service_accounts = args[:target_service_accounts] if args.key?(:target_service_accounts) @target_tags = args[:target_tags] if args.key?(:target_tags) end @@ -4583,16 +4608,28 @@ module Google include Google::Apis::Core::Hashable # The IP address that this forwarding rule is serving on behalf of. - # For global forwarding rules, the address must be a global IP. For regional - # forwarding rules, the address must live in the same region as the forwarding - # rule. By default, this field is empty and an ephemeral IPv4 address from the - # same scope (global or regional) will be assigned. A regional forwarding rule - # supports IPv4 only. A global forwarding rule supports either IPv4 or IPv6. + # Addresses are restricted based on the forwarding rule's load balancing scheme ( + # EXTERNAL or INTERNAL) and scope (global or regional). + # When the load balancing scheme is EXTERNAL, for global forwarding rules, the + # address must be a global IP, and for regional forwarding rules, the address + # must live in the same region as the forwarding rule. If this field is empty, + # an ephemeral IPv4 address from the same scope (global or regional) will be + # assigned. A regional forwarding rule supports IPv4 only. A global forwarding + # rule supports either IPv4 or IPv6. # When the load balancing scheme is INTERNAL, this can only be an RFC 1918 IP - # address belonging to the network/subnetwork configured for the forwarding rule. - # A reserved address cannot be used. If the field is empty, the IP address will - # be automatically allocated from the internal IP range of the subnetwork or - # network configured for this forwarding rule. + # address belonging to the network/subnet configured for the forwarding rule. By + # default, if this field is empty, an ephemeral internal IP address will be + # automatically allocated from the IP range of the subnet or network configured + # for this forwarding rule. + # An address can be specified either by a literal IP address or a URL reference + # to an existing Address resource. The following examples are all valid: + # - 100.1.2.3 + # - https://www.googleapis.com/compute/v1/projects/project/regions/region/ + # addresses/address + # - projects/project/regions/region/addresses/address + # - regions/region/addresses/address + # - global/addresses/address + # - address # Corresponds to the JSON property `IPAddress` # @return [String] attr_accessor :ip_address @@ -6383,6 +6420,12 @@ module Google # @return [String] attr_accessor :creation_timestamp + # Whether the resource should be protected against deletion. + # Corresponds to the JSON property `deletionProtection` + # @return [Boolean] + attr_accessor :deletion_protection + alias_method :deletion_protection?, :deletion_protection + # An optional description of this resource. Provide this property when you # create the resource. # Corresponds to the JSON property `description` @@ -6531,6 +6574,7 @@ module Google @can_ip_forward = args[:can_ip_forward] if args.key?(:can_ip_forward) @cpu_platform = args[:cpu_platform] if args.key?(:cpu_platform) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) + @deletion_protection = args[:deletion_protection] if args.key?(:deletion_protection) @description = args[:description] if args.key?(:description) @disks = args[:disks] if args.key?(:disks) @guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators) @@ -8695,6 +8739,1112 @@ module Google end end + # Protocol definitions for Mixer API to support Interconnect. Next available tag: + # 25 + class Interconnect + include Google::Apis::Core::Hashable + + # Administrative status of the interconnect. When this is set to ?true?, the + # Interconnect is functional and may carry traffic (assuming there are + # functional InterconnectAttachments and other requirements are satisfied). When + # set to ?false?, no packets will be carried over this Interconnect and no BGP + # routes will be exchanged over it. By default, it is set to ?true?. + # Corresponds to the JSON property `adminEnabled` + # @return [Boolean] + attr_accessor :admin_enabled + alias_method :admin_enabled?, :admin_enabled + + # [Output Only] List of CircuitInfo objects, that describe the individual + # circuits in this LAG. + # Corresponds to the JSON property `circuitInfos` + # @return [Array] + attr_accessor :circuit_infos + + # [Output Only] Creation timestamp in RFC3339 text format. + # Corresponds to the JSON property `creationTimestamp` + # @return [String] + attr_accessor :creation_timestamp + + # Customer name, to put in the Letter of Authorization as the party authorized + # to request a crossconnect. + # Corresponds to the JSON property `customerName` + # @return [String] + attr_accessor :customer_name + + # An optional description of this resource. Provide this property when you + # create the resource. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # [Output Only] List of outages expected for this Interconnect. + # Corresponds to the JSON property `expectedOutages` + # @return [Array] + attr_accessor :expected_outages + + # [Output Only] IP address configured on the Google side of the Interconnect + # link. This can be used only for ping tests. + # Corresponds to the JSON property `googleIpAddress` + # @return [String] + attr_accessor :google_ip_address + + # [Output Only] Google reference ID; to be used when raising support tickets + # with Google or otherwise to debug backend connectivity issues. + # Corresponds to the JSON property `googleReferenceId` + # @return [String] + attr_accessor :google_reference_id + + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # [Output Only] A list of the URLs of all InterconnectAttachments configured to + # use this Interconnect. + # Corresponds to the JSON property `interconnectAttachments` + # @return [Array] + attr_accessor :interconnect_attachments + + # + # Corresponds to the JSON property `interconnectType` + # @return [String] + attr_accessor :interconnect_type + + # [Output Only] Type of the resource. Always compute#interconnect for + # interconnects. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # + # Corresponds to the JSON property `linkType` + # @return [String] + attr_accessor :link_type + + # URL of the InterconnectLocation object that represents where this connection + # is to be provisioned. + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + # Name of the resource. Provided by the client when the resource is created. The + # name must be 1-63 characters long, and comply with RFC1035. Specifically, the + # name must be 1-63 characters long and match the regular expression [a-z]([-a- + # z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, + # and all following characters must be a dash, lowercase letter, or digit, + # except the last character, which cannot be a dash. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Email address to contact the customer NOC for operations and maintenance + # notifications regarding this Interconnect. If specified, this will be used for + # notifications in addition to all other forms described, such as Stackdriver + # logs alerting and Cloud Notifications. + # Corresponds to the JSON property `nocContactEmail` + # @return [String] + attr_accessor :noc_contact_email + + # [Output Only] The current status of whether or not this Interconnect is + # functional. + # Corresponds to the JSON property `operationalStatus` + # @return [String] + attr_accessor :operational_status + + # [Output Only] IP address configured on the customer side of the Interconnect + # link. The customer should configure this IP address during turnup when + # prompted by Google NOC. This can be used only for ping tests. + # Corresponds to the JSON property `peerIpAddress` + # @return [String] + attr_accessor :peer_ip_address + + # [Output Only] Number of links actually provisioned in this interconnect. + # Corresponds to the JSON property `provisionedLinkCount` + # @return [Fixnum] + attr_accessor :provisioned_link_count + + # Target number of physical links in the link bundle, as requested by the + # customer. + # Corresponds to the JSON property `requestedLinkCount` + # @return [Fixnum] + attr_accessor :requested_link_count + + # [Output Only] Server-defined URL for the resource. + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @admin_enabled = args[:admin_enabled] if args.key?(:admin_enabled) + @circuit_infos = args[:circuit_infos] if args.key?(:circuit_infos) + @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) + @customer_name = args[:customer_name] if args.key?(:customer_name) + @description = args[:description] if args.key?(:description) + @expected_outages = args[:expected_outages] if args.key?(:expected_outages) + @google_ip_address = args[:google_ip_address] if args.key?(:google_ip_address) + @google_reference_id = args[:google_reference_id] if args.key?(:google_reference_id) + @id = args[:id] if args.key?(:id) + @interconnect_attachments = args[:interconnect_attachments] if args.key?(:interconnect_attachments) + @interconnect_type = args[:interconnect_type] if args.key?(:interconnect_type) + @kind = args[:kind] if args.key?(:kind) + @link_type = args[:link_type] if args.key?(:link_type) + @location = args[:location] if args.key?(:location) + @name = args[:name] if args.key?(:name) + @noc_contact_email = args[:noc_contact_email] if args.key?(:noc_contact_email) + @operational_status = args[:operational_status] if args.key?(:operational_status) + @peer_ip_address = args[:peer_ip_address] if args.key?(:peer_ip_address) + @provisioned_link_count = args[:provisioned_link_count] if args.key?(:provisioned_link_count) + @requested_link_count = args[:requested_link_count] if args.key?(:requested_link_count) + @self_link = args[:self_link] if args.key?(:self_link) + end + end + + # Protocol definitions for Mixer API to support InterconnectAttachment. Next + # available tag: 23 + class InterconnectAttachment + include Google::Apis::Core::Hashable + + # [Output Only] IPv4 address + prefix length to be configured on Cloud Router + # Interface for this interconnect attachment. + # Corresponds to the JSON property `cloudRouterIpAddress` + # @return [String] + attr_accessor :cloud_router_ip_address + + # [Output Only] Creation timestamp in RFC3339 text format. + # Corresponds to the JSON property `creationTimestamp` + # @return [String] + attr_accessor :creation_timestamp + + # [Output Only] IPv4 address + prefix length to be configured on the customer + # router subinterface for this interconnect attachment. + # Corresponds to the JSON property `customerRouterIpAddress` + # @return [String] + attr_accessor :customer_router_ip_address + + # An optional description of this resource. Provide this property when you + # create the resource. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # [Output Only] Google reference ID, to be used when raising support tickets + # with Google or otherwise to debug backend connectivity issues. + # Corresponds to the JSON property `googleReferenceId` + # @return [String] + attr_accessor :google_reference_id + + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # URL of the underlying Interconnect object that this attachment's traffic will + # traverse through. + # Corresponds to the JSON property `interconnect` + # @return [String] + attr_accessor :interconnect + + # [Output Only] Type of the resource. Always compute#interconnectAttachment for + # interconnect attachments. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of the resource. Provided by the client when the resource is created. The + # name must be 1-63 characters long, and comply with RFC1035. Specifically, the + # name must be 1-63 characters long and match the regular expression [a-z]([-a- + # z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, + # and all following characters must be a dash, lowercase letter, or digit, + # except the last character, which cannot be a dash. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # [Output Only] The current status of whether or not this interconnect + # attachment is functional. + # Corresponds to the JSON property `operationalStatus` + # @return [String] + attr_accessor :operational_status + + # Private information for an interconnect attachment when this belongs to an + # interconnect of type IT_PRIVATE. + # Corresponds to the JSON property `privateInterconnectInfo` + # @return [Google::Apis::ComputeV1::InterconnectAttachmentPrivateInfo] + attr_accessor :private_interconnect_info + + # [Output Only] URL of the region where the regional interconnect attachment + # resides. + # Corresponds to the JSON property `region` + # @return [String] + attr_accessor :region + + # URL of the cloud router to be used for dynamic routing. This router must be in + # the same region as this InterconnectAttachment. The InterconnectAttachment + # will automatically connect the Interconnect to the network & region within + # which the Cloud Router is configured. + # Corresponds to the JSON property `router` + # @return [String] + attr_accessor :router + + # [Output Only] Server-defined URL for the resource. + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cloud_router_ip_address = args[:cloud_router_ip_address] if args.key?(:cloud_router_ip_address) + @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) + @customer_router_ip_address = args[:customer_router_ip_address] if args.key?(:customer_router_ip_address) + @description = args[:description] if args.key?(:description) + @google_reference_id = args[:google_reference_id] if args.key?(:google_reference_id) + @id = args[:id] if args.key?(:id) + @interconnect = args[:interconnect] if args.key?(:interconnect) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @operational_status = args[:operational_status] if args.key?(:operational_status) + @private_interconnect_info = args[:private_interconnect_info] if args.key?(:private_interconnect_info) + @region = args[:region] if args.key?(:region) + @router = args[:router] if args.key?(:router) + @self_link = args[:self_link] if args.key?(:self_link) + end + end + + # + class InterconnectAttachmentAggregatedList + include Google::Apis::Core::Hashable + + # [Output Only] Unique identifier for the resource; defined by the server. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # A list of InterconnectAttachmentsScopedList resources. + # Corresponds to the JSON property `items` + # @return [Hash] + attr_accessor :items + + # [Output Only] Type of resource. Always compute# + # interconnectAttachmentAggregatedList for aggregated lists of interconnect + # attachments. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # [Output Only] Server-defined URL for this resource. + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + # [Output Only] Informational warning message. + # Corresponds to the JSON property `warning` + # @return [Google::Apis::ComputeV1::InterconnectAttachmentAggregatedList::Warning] + attr_accessor :warning + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @self_link = args[:self_link] if args.key?(:self_link) + @warning = args[:warning] if args.key?(:warning) + end + + # [Output Only] Informational warning message. + class Warning + include Google::Apis::Core::Hashable + + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` + # Corresponds to the JSON property `data` + # @return [Array] + attr_accessor :data + + # [Output Only] A human-readable description of the warning code. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @data = args[:data] if args.key?(:data) + @message = args[:message] if args.key?(:message) + end + + # + class Datum + include Google::Apis::Core::Hashable + + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # [Output Only] A warning data value corresponding to the key. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key = args[:key] if args.key?(:key) + @value = args[:value] if args.key?(:value) + end + end + end + end + + # Response to the list request, and contains a list of interconnect attachments. + class InterconnectAttachmentList + include Google::Apis::Core::Hashable + + # [Output Only] Unique identifier for the resource; defined by the server. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # A list of InterconnectAttachment resources. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # [Output Only] Type of resource. Always compute#interconnectAttachmentList for + # lists of interconnect attachments. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # [Output Only] Server-defined URL for this resource. + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + # [Output Only] Informational warning message. + # Corresponds to the JSON property `warning` + # @return [Google::Apis::ComputeV1::InterconnectAttachmentList::Warning] + attr_accessor :warning + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @self_link = args[:self_link] if args.key?(:self_link) + @warning = args[:warning] if args.key?(:warning) + end + + # [Output Only] Informational warning message. + class Warning + include Google::Apis::Core::Hashable + + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` + # Corresponds to the JSON property `data` + # @return [Array] + attr_accessor :data + + # [Output Only] A human-readable description of the warning code. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @data = args[:data] if args.key?(:data) + @message = args[:message] if args.key?(:message) + end + + # + class Datum + include Google::Apis::Core::Hashable + + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # [Output Only] A warning data value corresponding to the key. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key = args[:key] if args.key?(:key) + @value = args[:value] if args.key?(:value) + end + end + end + end + + # Private information for an interconnect attachment when this belongs to an + # interconnect of type IT_PRIVATE. + class InterconnectAttachmentPrivateInfo + include Google::Apis::Core::Hashable + + # [Output Only] 802.1q encapsulation tag to be used for traffic between Google + # and the customer, going to and from this network and region. + # Corresponds to the JSON property `tag8021q` + # @return [Fixnum] + attr_accessor :tag8021q + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @tag8021q = args[:tag8021q] if args.key?(:tag8021q) + end + end + + # + class InterconnectAttachmentsScopedList + include Google::Apis::Core::Hashable + + # List of interconnect attachments contained in this scope. + # Corresponds to the JSON property `interconnectAttachments` + # @return [Array] + attr_accessor :interconnect_attachments + + # Informational warning which replaces the list of addresses when the list is + # empty. + # Corresponds to the JSON property `warning` + # @return [Google::Apis::ComputeV1::InterconnectAttachmentsScopedList::Warning] + attr_accessor :warning + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @interconnect_attachments = args[:interconnect_attachments] if args.key?(:interconnect_attachments) + @warning = args[:warning] if args.key?(:warning) + end + + # Informational warning which replaces the list of addresses when the list is + # empty. + class Warning + include Google::Apis::Core::Hashable + + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` + # Corresponds to the JSON property `data` + # @return [Array] + attr_accessor :data + + # [Output Only] A human-readable description of the warning code. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @data = args[:data] if args.key?(:data) + @message = args[:message] if args.key?(:message) + end + + # + class Datum + include Google::Apis::Core::Hashable + + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # [Output Only] A warning data value corresponding to the key. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key = args[:key] if args.key?(:key) + @value = args[:value] if args.key?(:value) + end + end + end + end + + # Describes a single physical circuit between the Customer and Google. + # CircuitInfo objects are created by Google, so all fields are output only. Next + # id: 4 + class InterconnectCircuitInfo + include Google::Apis::Core::Hashable + + # Customer-side demarc ID for this circuit. This will only be set if it was + # provided by the Customer to Google during circuit turn-up. + # Corresponds to the JSON property `customerDemarcId` + # @return [String] + attr_accessor :customer_demarc_id + + # Google-assigned unique ID for this circuit. Assigned at circuit turn-up. + # Corresponds to the JSON property `googleCircuitId` + # @return [String] + attr_accessor :google_circuit_id + + # Google-side demarc ID for this circuit. Assigned at circuit turn-up and + # provided by Google to the customer in the LOA. + # Corresponds to the JSON property `googleDemarcId` + # @return [String] + attr_accessor :google_demarc_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @customer_demarc_id = args[:customer_demarc_id] if args.key?(:customer_demarc_id) + @google_circuit_id = args[:google_circuit_id] if args.key?(:google_circuit_id) + @google_demarc_id = args[:google_demarc_id] if args.key?(:google_demarc_id) + end + end + + # Response to the list request, and contains a list of interconnects. + class InterconnectList + include Google::Apis::Core::Hashable + + # [Output Only] Unique identifier for the resource; defined by the server. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # A list of Interconnect resources. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # [Output Only] Type of resource. Always compute#interconnectList for lists of + # interconnects. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # [Output Only] Server-defined URL for this resource. + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + # [Output Only] Informational warning message. + # Corresponds to the JSON property `warning` + # @return [Google::Apis::ComputeV1::InterconnectList::Warning] + attr_accessor :warning + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @self_link = args[:self_link] if args.key?(:self_link) + @warning = args[:warning] if args.key?(:warning) + end + + # [Output Only] Informational warning message. + class Warning + include Google::Apis::Core::Hashable + + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` + # Corresponds to the JSON property `data` + # @return [Array] + attr_accessor :data + + # [Output Only] A human-readable description of the warning code. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @data = args[:data] if args.key?(:data) + @message = args[:message] if args.key?(:message) + end + + # + class Datum + include Google::Apis::Core::Hashable + + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # [Output Only] A warning data value corresponding to the key. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key = args[:key] if args.key?(:key) + @value = args[:value] if args.key?(:value) + end + end + end + end + + # Protocol definitions for Mixer API to support InterconnectLocation. + class InterconnectLocation + include Google::Apis::Core::Hashable + + # [Output Only] The postal address of the Point of Presence, each line in the + # address is separated by a newline character. + # Corresponds to the JSON property `address` + # @return [String] + attr_accessor :address + + # Availability zone for this location. Within a city, maintenance will not be + # simultaneously scheduled in more than one availability zone. Example: "zone1" + # or "zone2". + # Corresponds to the JSON property `availabilityZone` + # @return [String] + attr_accessor :availability_zone + + # City designator used by the Interconnect UI to locate this + # InterconnectLocation within the Continent. For example: "Chicago, IL", " + # Amsterdam, Netherlands". + # Corresponds to the JSON property `city` + # @return [String] + attr_accessor :city + + # Continent for this location. Used by the location picker in the Interconnect + # UI. + # Corresponds to the JSON property `continent` + # @return [String] + attr_accessor :continent + + # [Output Only] Creation timestamp in RFC3339 text format. + # Corresponds to the JSON property `creationTimestamp` + # @return [String] + attr_accessor :creation_timestamp + + # [Output Only] An optional description of the resource. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # [Output Only] The name of the provider for this facility (e.g., EQUINIX). + # Corresponds to the JSON property `facilityProvider` + # @return [String] + attr_accessor :facility_provider + + # [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn- + # DC1). + # Corresponds to the JSON property `facilityProviderFacilityId` + # @return [String] + attr_accessor :facility_provider_facility_id + + # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # [Output Only] Type of the resource. Always compute#interconnectLocation for + # interconnect locations. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # [Output Only] Name of the resource. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # [Output Only] The peeringdb identifier for this facility (corresponding with a + # netfac type in peeringdb). + # Corresponds to the JSON property `peeringdbFacilityId` + # @return [String] + attr_accessor :peeringdb_facility_id + + # [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe + # parameters pertaining to the relation between this InterconnectLocation and + # various Google Cloud regions. + # Corresponds to the JSON property `regionInfos` + # @return [Array] + attr_accessor :region_infos + + # [Output Only] Server-defined URL for the resource. + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @address = args[:address] if args.key?(:address) + @availability_zone = args[:availability_zone] if args.key?(:availability_zone) + @city = args[:city] if args.key?(:city) + @continent = args[:continent] if args.key?(:continent) + @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) + @description = args[:description] if args.key?(:description) + @facility_provider = args[:facility_provider] if args.key?(:facility_provider) + @facility_provider_facility_id = args[:facility_provider_facility_id] if args.key?(:facility_provider_facility_id) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @peeringdb_facility_id = args[:peeringdb_facility_id] if args.key?(:peeringdb_facility_id) + @region_infos = args[:region_infos] if args.key?(:region_infos) + @self_link = args[:self_link] if args.key?(:self_link) + end + end + + # Response to the list request, and contains a list of interconnect locations. + class InterconnectLocationList + include Google::Apis::Core::Hashable + + # [Output Only] Unique identifier for the resource; defined by the server. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # A list of InterconnectLocation resources. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # [Output Only] Type of resource. Always compute#interconnectLocationList for + # lists of interconnect locations. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # [Output Only] This token allows you to get the next page of results for list + # requests. If the number of results is larger than maxResults, use the + # nextPageToken as a value for the query parameter pageToken in the next list + # request. Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # [Output Only] Server-defined URL for this resource. + # Corresponds to the JSON property `selfLink` + # @return [String] + attr_accessor :self_link + + # [Output Only] Informational warning message. + # Corresponds to the JSON property `warning` + # @return [Google::Apis::ComputeV1::InterconnectLocationList::Warning] + attr_accessor :warning + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @self_link = args[:self_link] if args.key?(:self_link) + @warning = args[:warning] if args.key?(:warning) + end + + # [Output Only] Informational warning message. + class Warning + include Google::Apis::Core::Hashable + + # [Output Only] A warning code, if applicable. For example, Compute Engine + # returns NO_RESULTS_ON_PAGE if there are no results in the response. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # [Output Only] Metadata about this warning in key: value format. For example: + # "data": [ ` "key": "scope", "value": "zones/us-east1-d" ` + # Corresponds to the JSON property `data` + # @return [Array] + attr_accessor :data + + # [Output Only] A human-readable description of the warning code. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @data = args[:data] if args.key?(:data) + @message = args[:message] if args.key?(:message) + end + + # + class Datum + include Google::Apis::Core::Hashable + + # [Output Only] A key that provides more detail on the warning being returned. + # For example, for warnings where there are no results in a list request for a + # particular zone, this key might be scope and the key value might be the zone + # name. Other examples might be a key indicating a deprecated resource and a + # suggested replacement, or a warning about invalid network settings (for + # example, if an instance attempts to perform IP forwarding but is not enabled + # for IP forwarding). + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # [Output Only] A warning data value corresponding to the key. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key = args[:key] if args.key?(:key) + @value = args[:value] if args.key?(:value) + end + end + end + end + + # Information about any potential InterconnectAttachments between an + # Interconnect at a specific InterconnectLocation, and a specific Cloud Region. + class InterconnectLocationRegionInfo + include Google::Apis::Core::Hashable + + # Expected round-trip time in milliseconds, from this InterconnectLocation to a + # VM in this region. + # Corresponds to the JSON property `expectedRttMs` + # @return [Fixnum] + attr_accessor :expected_rtt_ms + + # Identifies the network presence of this location. + # Corresponds to the JSON property `locationPresence` + # @return [String] + attr_accessor :location_presence + + # URL for the region of this location. + # Corresponds to the JSON property `region` + # @return [String] + attr_accessor :region + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @expected_rtt_ms = args[:expected_rtt_ms] if args.key?(:expected_rtt_ms) + @location_presence = args[:location_presence] if args.key?(:location_presence) + @region = args[:region] if args.key?(:region) + end + end + + # Description of a planned outage on this Interconnect. Next id: 9 + class InterconnectOutageNotification + include Google::Apis::Core::Hashable + + # Iff issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs + # that will be affected. + # Corresponds to the JSON property `affectedCircuits` + # @return [Array] + attr_accessor :affected_circuits + + # Short user-visible description of the purpose of the outage. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # + # Corresponds to the JSON property `endTime` + # @return [Fixnum] + attr_accessor :end_time + + # + # Corresponds to the JSON property `issueType` + # @return [String] + attr_accessor :issue_type + + # Unique identifier for this outage notification. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # + # Corresponds to the JSON property `source` + # @return [String] + attr_accessor :source + + # Scheduled start and end times for the outage (milliseconds since Unix epoch). + # Corresponds to the JSON property `startTime` + # @return [Fixnum] + attr_accessor :start_time + + # + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @affected_circuits = args[:affected_circuits] if args.key?(:affected_circuits) + @description = args[:description] if args.key?(:description) + @end_time = args[:end_time] if args.key?(:end_time) + @issue_type = args[:issue_type] if args.key?(:issue_type) + @name = args[:name] if args.key?(:name) + @source = args[:source] if args.key?(:source) + @start_time = args[:start_time] if args.key?(:start_time) + @state = args[:state] if args.key?(:state) + end + end + # A license resource. class License include Google::Apis::Core::Hashable @@ -12290,6 +13440,13 @@ module Google # @return [String] attr_accessor :ip_range + # URI of the linked interconnect attachment. It must be in the same region as + # the router. Each interface can have at most one linked resource and it could + # either be a VPN Tunnel or an interconnect attachment. + # Corresponds to the JSON property `linkedInterconnectAttachment` + # @return [String] + attr_accessor :linked_interconnect_attachment + # URI of the linked VPN tunnel. It must be in the same region as the router. # Each interface can have at most one linked resource and it could either be a # VPN Tunnel or an interconnect attachment. @@ -12310,6 +13467,7 @@ module Google # Update properties of this object def update!(**args) @ip_range = args[:ip_range] if args.key?(:ip_range) + @linked_interconnect_attachment = args[:linked_interconnect_attachment] if args.key?(:linked_interconnect_attachment) @linked_vpn_tunnel = args[:linked_vpn_tunnel] if args.key?(:linked_vpn_tunnel) @name = args[:name] if args.key?(:name) end diff --git a/generated/google/apis/compute_v1/representations.rb b/generated/google/apis/compute_v1/representations.rb index d908438db..9c7713c86 100644 --- a/generated/google/apis/compute_v1/representations.rb +++ b/generated/google/apis/compute_v1/representations.rb @@ -1186,6 +1186,138 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Interconnect + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InterconnectAttachment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InterconnectAttachmentAggregatedList + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Warning + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Datum + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class InterconnectAttachmentList + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Warning + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Datum + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class InterconnectAttachmentPrivateInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InterconnectAttachmentsScopedList + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Warning + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Datum + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class InterconnectCircuitInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InterconnectList + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Warning + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Datum + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class InterconnectLocation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InterconnectLocationList + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Warning + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Datum + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class InterconnectLocationRegionInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InterconnectOutageNotification + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class License class Representation < Google::Apis::Core::JsonRepresentation; end @@ -3549,7 +3681,9 @@ module Google property :priority, as: 'priority' property :self_link, as: 'selfLink' collection :source_ranges, as: 'sourceRanges' + collection :source_service_accounts, as: 'sourceServiceAccounts' collection :source_tags, as: 'sourceTags' + collection :target_service_accounts, as: 'targetServiceAccounts' collection :target_tags, as: 'targetTags' end @@ -4022,6 +4156,7 @@ module Google property :can_ip_forward, as: 'canIpForward' property :cpu_platform, as: 'cpuPlatform' property :creation_timestamp, as: 'creationTimestamp' + property :deletion_protection, as: 'deletionProtection' property :description, as: 'description' collection :disks, as: 'disks', class: Google::Apis::ComputeV1::AttachedDisk, decorator: Google::Apis::ComputeV1::AttachedDisk::Representation @@ -4636,6 +4771,272 @@ module Google end end + class Interconnect + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :admin_enabled, as: 'adminEnabled' + collection :circuit_infos, as: 'circuitInfos', class: Google::Apis::ComputeV1::InterconnectCircuitInfo, decorator: Google::Apis::ComputeV1::InterconnectCircuitInfo::Representation + + property :creation_timestamp, as: 'creationTimestamp' + property :customer_name, as: 'customerName' + property :description, as: 'description' + collection :expected_outages, as: 'expectedOutages', class: Google::Apis::ComputeV1::InterconnectOutageNotification, decorator: Google::Apis::ComputeV1::InterconnectOutageNotification::Representation + + property :google_ip_address, as: 'googleIpAddress' + property :google_reference_id, as: 'googleReferenceId' + property :id, :numeric_string => true, as: 'id' + collection :interconnect_attachments, as: 'interconnectAttachments' + property :interconnect_type, as: 'interconnectType' + property :kind, as: 'kind' + property :link_type, as: 'linkType' + property :location, as: 'location' + property :name, as: 'name' + property :noc_contact_email, as: 'nocContactEmail' + property :operational_status, as: 'operationalStatus' + property :peer_ip_address, as: 'peerIpAddress' + property :provisioned_link_count, as: 'provisionedLinkCount' + property :requested_link_count, as: 'requestedLinkCount' + property :self_link, as: 'selfLink' + end + end + + class InterconnectAttachment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cloud_router_ip_address, as: 'cloudRouterIpAddress' + property :creation_timestamp, as: 'creationTimestamp' + property :customer_router_ip_address, as: 'customerRouterIpAddress' + property :description, as: 'description' + property :google_reference_id, as: 'googleReferenceId' + property :id, :numeric_string => true, as: 'id' + property :interconnect, as: 'interconnect' + property :kind, as: 'kind' + property :name, as: 'name' + property :operational_status, as: 'operationalStatus' + property :private_interconnect_info, as: 'privateInterconnectInfo', class: Google::Apis::ComputeV1::InterconnectAttachmentPrivateInfo, decorator: Google::Apis::ComputeV1::InterconnectAttachmentPrivateInfo::Representation + + property :region, as: 'region' + property :router, as: 'router' + property :self_link, as: 'selfLink' + end + end + + class InterconnectAttachmentAggregatedList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + hash :items, as: 'items', class: Google::Apis::ComputeV1::InterconnectAttachmentsScopedList, decorator: Google::Apis::ComputeV1::InterconnectAttachmentsScopedList::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + property :self_link, as: 'selfLink' + property :warning, as: 'warning', class: Google::Apis::ComputeV1::InterconnectAttachmentAggregatedList::Warning, decorator: Google::Apis::ComputeV1::InterconnectAttachmentAggregatedList::Warning::Representation + + end + + class Warning + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :data, as: 'data', class: Google::Apis::ComputeV1::InterconnectAttachmentAggregatedList::Warning::Datum, decorator: Google::Apis::ComputeV1::InterconnectAttachmentAggregatedList::Warning::Datum::Representation + + property :message, as: 'message' + end + + class Datum + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + end + end + + class InterconnectAttachmentList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + collection :items, as: 'items', class: Google::Apis::ComputeV1::InterconnectAttachment, decorator: Google::Apis::ComputeV1::InterconnectAttachment::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + property :self_link, as: 'selfLink' + property :warning, as: 'warning', class: Google::Apis::ComputeV1::InterconnectAttachmentList::Warning, decorator: Google::Apis::ComputeV1::InterconnectAttachmentList::Warning::Representation + + end + + class Warning + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :data, as: 'data', class: Google::Apis::ComputeV1::InterconnectAttachmentList::Warning::Datum, decorator: Google::Apis::ComputeV1::InterconnectAttachmentList::Warning::Datum::Representation + + property :message, as: 'message' + end + + class Datum + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + end + end + + class InterconnectAttachmentPrivateInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :tag8021q, as: 'tag8021q' + end + end + + class InterconnectAttachmentsScopedList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :interconnect_attachments, as: 'interconnectAttachments', class: Google::Apis::ComputeV1::InterconnectAttachment, decorator: Google::Apis::ComputeV1::InterconnectAttachment::Representation + + property :warning, as: 'warning', class: Google::Apis::ComputeV1::InterconnectAttachmentsScopedList::Warning, decorator: Google::Apis::ComputeV1::InterconnectAttachmentsScopedList::Warning::Representation + + end + + class Warning + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :data, as: 'data', class: Google::Apis::ComputeV1::InterconnectAttachmentsScopedList::Warning::Datum, decorator: Google::Apis::ComputeV1::InterconnectAttachmentsScopedList::Warning::Datum::Representation + + property :message, as: 'message' + end + + class Datum + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + end + end + + class InterconnectCircuitInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :customer_demarc_id, as: 'customerDemarcId' + property :google_circuit_id, as: 'googleCircuitId' + property :google_demarc_id, as: 'googleDemarcId' + end + end + + class InterconnectList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + collection :items, as: 'items', class: Google::Apis::ComputeV1::Interconnect, decorator: Google::Apis::ComputeV1::Interconnect::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + property :self_link, as: 'selfLink' + property :warning, as: 'warning', class: Google::Apis::ComputeV1::InterconnectList::Warning, decorator: Google::Apis::ComputeV1::InterconnectList::Warning::Representation + + end + + class Warning + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :data, as: 'data', class: Google::Apis::ComputeV1::InterconnectList::Warning::Datum, decorator: Google::Apis::ComputeV1::InterconnectList::Warning::Datum::Representation + + property :message, as: 'message' + end + + class Datum + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + end + end + + class InterconnectLocation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :address, as: 'address' + property :availability_zone, as: 'availabilityZone' + property :city, as: 'city' + property :continent, as: 'continent' + property :creation_timestamp, as: 'creationTimestamp' + property :description, as: 'description' + property :facility_provider, as: 'facilityProvider' + property :facility_provider_facility_id, as: 'facilityProviderFacilityId' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :peeringdb_facility_id, as: 'peeringdbFacilityId' + collection :region_infos, as: 'regionInfos', class: Google::Apis::ComputeV1::InterconnectLocationRegionInfo, decorator: Google::Apis::ComputeV1::InterconnectLocationRegionInfo::Representation + + property :self_link, as: 'selfLink' + end + end + + class InterconnectLocationList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + collection :items, as: 'items', class: Google::Apis::ComputeV1::InterconnectLocation, decorator: Google::Apis::ComputeV1::InterconnectLocation::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + property :self_link, as: 'selfLink' + property :warning, as: 'warning', class: Google::Apis::ComputeV1::InterconnectLocationList::Warning, decorator: Google::Apis::ComputeV1::InterconnectLocationList::Warning::Representation + + end + + class Warning + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :data, as: 'data', class: Google::Apis::ComputeV1::InterconnectLocationList::Warning::Datum, decorator: Google::Apis::ComputeV1::InterconnectLocationList::Warning::Datum::Representation + + property :message, as: 'message' + end + + class Datum + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + end + end + + class InterconnectLocationRegionInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :expected_rtt_ms, :numeric_string => true, as: 'expectedRttMs' + property :location_presence, as: 'locationPresence' + property :region, as: 'region' + end + end + + class InterconnectOutageNotification + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :affected_circuits, as: 'affectedCircuits' + property :description, as: 'description' + property :end_time, :numeric_string => true, as: 'endTime' + property :issue_type, as: 'issueType' + property :name, as: 'name' + property :source, as: 'source' + property :start_time, :numeric_string => true, as: 'startTime' + property :state, as: 'state' + end + end + class License # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -5575,6 +5976,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :ip_range, as: 'ipRange' + property :linked_interconnect_attachment, as: 'linkedInterconnectAttachment' property :linked_vpn_tunnel, as: 'linkedVpnTunnel' property :name, as: 'name' end diff --git a/generated/google/apis/compute_v1/service.rb b/generated/google/apis/compute_v1/service.rb index 060b9cbed..2dc0add6c 100644 --- a/generated/google/apis/compute_v1/service.rb +++ b/generated/google/apis/compute_v1/service.rb @@ -7341,6 +7341,62 @@ module Google execute_or_queue_command(command, &block) end + # Sets deletion protection on the instance. + # @param [String] project + # Project ID for this request. + # @param [String] zone + # The name of the zone for this request. + # @param [String] resource + # Name of the resource for this request. + # @param [Boolean] deletion_protection + # Whether the resource should be protected against deletion. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_instance_deletion_protection(project, zone, resource, deletion_protection: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/zones/{zone}/instances/{resource}/setDeletionProtection', options) + command.response_representation = Google::Apis::ComputeV1::Operation::Representation + command.response_class = Google::Apis::ComputeV1::Operation + command.params['project'] = project unless project.nil? + command.params['zone'] = zone unless zone.nil? + command.params['resource'] = resource unless resource.nil? + command.query['deletionProtection'] = deletion_protection unless deletion_protection.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Sets the auto-delete flag for a disk attached to an instance. # @param [String] project # Project ID for this request. @@ -7966,11 +8022,10 @@ module Google end # Stops a running instance, shutting it down cleanly, and allows you to restart - # the instance at a later time. Stopped instances do not incur per-minute, - # virtual machine usage charges while they are stopped, but any resources that - # the virtual machine is using, such as persistent disks and static IP addresses, - # will continue to be charged until they are deleted. For more information, see - # Stopping an instance. + # the instance at a later time. Stopped instances do not incur VM usage charges + # while they are stopped. However, resources that the VM is using, such as + # persistent disks and static IP addresses, will continue to be charged until + # they are deleted. For more information, see Stopping an instance. # @param [String] project # Project ID for this request. # @param [String] zone @@ -8023,6 +8078,697 @@ module Google execute_or_queue_command(command, &block) end + # Retrieves an aggregated list of interconnect attachments. + # @param [String] project + # Project ID for this request. + # @param [String] filter + # Sets a filter `expression` for filtering listed resources. Your `expression` + # must be in the format: field_name comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. + # For example, to filter for instances that do not have a name of example- + # instance, you would use name ne example-instance. + # You can filter on nested fields. For example, you could filter on instances + # that have set the scheduling.automaticRestart field to true. Use filtering on + # nested fields to take advantage of labels to organize and search for results + # based on label values. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- + # central1-f). Multiple expressions are treated as AND expressions, meaning that + # resources must match all expressions to pass the filters. + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than maxResults, Compute Engine returns a + # nextPageToken that can be used to get the next page of results in subsequent + # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using orderBy="creationTimestamp desc". This sorts results based on the + # creationTimestamp field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by name or creationTimestamp desc is supported. + # @param [String] page_token + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::InterconnectAttachmentAggregatedList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::InterconnectAttachmentAggregatedList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def aggregated_interconnect_attachment_list(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/aggregated/interconnectAttachments', options) + command.response_representation = Google::Apis::ComputeV1::InterconnectAttachmentAggregatedList::Representation + command.response_class = Google::Apis::ComputeV1::InterconnectAttachmentAggregatedList + command.params['project'] = project unless project.nil? + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified interconnect attachment. + # @param [String] project + # Project ID for this request. + # @param [String] region + # Name of the region for this request. + # @param [String] interconnect_attachment + # Name of the interconnect attachment to delete. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_interconnect_attachment(project, region, interconnect_attachment, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}', options) + command.response_representation = Google::Apis::ComputeV1::Operation::Representation + command.response_class = Google::Apis::ComputeV1::Operation + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.params['interconnectAttachment'] = interconnect_attachment unless interconnect_attachment.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns the specified interconnect attachment. + # @param [String] project + # Project ID for this request. + # @param [String] region + # Name of the region for this request. + # @param [String] interconnect_attachment + # Name of the interconnect attachment to return. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::InterconnectAttachment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::InterconnectAttachment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_interconnect_attachment(project, region, interconnect_attachment, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}', options) + command.response_representation = Google::Apis::ComputeV1::InterconnectAttachment::Representation + command.response_class = Google::Apis::ComputeV1::InterconnectAttachment + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.params['interconnectAttachment'] = interconnect_attachment unless interconnect_attachment.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Creates an InterconnectAttachment in the specified project using the data + # included in the request. + # @param [String] project + # Project ID for this request. + # @param [String] region + # Name of the region for this request. + # @param [Google::Apis::ComputeV1::InterconnectAttachment] interconnect_attachment_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_interconnect_attachment(project, region, interconnect_attachment_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/regions/{region}/interconnectAttachments', options) + command.request_representation = Google::Apis::ComputeV1::InterconnectAttachment::Representation + command.request_object = interconnect_attachment_object + command.response_representation = Google::Apis::ComputeV1::Operation::Representation + command.response_class = Google::Apis::ComputeV1::Operation + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of interconnect attachments contained within the specified + # region. + # @param [String] project + # Project ID for this request. + # @param [String] region + # Name of the region for this request. + # @param [String] filter + # Sets a filter `expression` for filtering listed resources. Your `expression` + # must be in the format: field_name comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. + # For example, to filter for instances that do not have a name of example- + # instance, you would use name ne example-instance. + # You can filter on nested fields. For example, you could filter on instances + # that have set the scheduling.automaticRestart field to true. Use filtering on + # nested fields to take advantage of labels to organize and search for results + # based on label values. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- + # central1-f). Multiple expressions are treated as AND expressions, meaning that + # resources must match all expressions to pass the filters. + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than maxResults, Compute Engine returns a + # nextPageToken that can be used to get the next page of results in subsequent + # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using orderBy="creationTimestamp desc". This sorts results based on the + # creationTimestamp field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by name or creationTimestamp desc is supported. + # @param [String] page_token + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::InterconnectAttachmentList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::InterconnectAttachmentList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_interconnect_attachments(project, region, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/regions/{region}/interconnectAttachments', options) + command.response_representation = Google::Apis::ComputeV1::InterconnectAttachmentList::Representation + command.response_class = Google::Apis::ComputeV1::InterconnectAttachmentList + command.params['project'] = project unless project.nil? + command.params['region'] = region unless region.nil? + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns the details for the specified interconnect location. Get a list of + # available interconnect locations by making a list() request. + # @param [String] project + # Project ID for this request. + # @param [String] interconnect_location + # Name of the interconnect location to return. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::InterconnectLocation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::InterconnectLocation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_interconnect_location(project, interconnect_location, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/global/interconnectLocations/{interconnectLocation}', options) + command.response_representation = Google::Apis::ComputeV1::InterconnectLocation::Representation + command.response_class = Google::Apis::ComputeV1::InterconnectLocation + command.params['project'] = project unless project.nil? + command.params['interconnectLocation'] = interconnect_location unless interconnect_location.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of interconnect locations available to the specified + # project. + # @param [String] project + # Project ID for this request. + # @param [String] filter + # Sets a filter `expression` for filtering listed resources. Your `expression` + # must be in the format: field_name comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. + # For example, to filter for instances that do not have a name of example- + # instance, you would use name ne example-instance. + # You can filter on nested fields. For example, you could filter on instances + # that have set the scheduling.automaticRestart field to true. Use filtering on + # nested fields to take advantage of labels to organize and search for results + # based on label values. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- + # central1-f). Multiple expressions are treated as AND expressions, meaning that + # resources must match all expressions to pass the filters. + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than maxResults, Compute Engine returns a + # nextPageToken that can be used to get the next page of results in subsequent + # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using orderBy="creationTimestamp desc". This sorts results based on the + # creationTimestamp field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by name or creationTimestamp desc is supported. + # @param [String] page_token + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::InterconnectLocationList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::InterconnectLocationList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_interconnect_locations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/global/interconnectLocations', options) + command.response_representation = Google::Apis::ComputeV1::InterconnectLocationList::Representation + command.response_class = Google::Apis::ComputeV1::InterconnectLocationList + command.params['project'] = project unless project.nil? + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified interconnect. + # @param [String] project + # Project ID for this request. + # @param [String] interconnect + # Name of the interconnect to delete. + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_interconnect(project, interconnect, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{project}/global/interconnects/{interconnect}', options) + command.response_representation = Google::Apis::ComputeV1::Operation::Representation + command.response_class = Google::Apis::ComputeV1::Operation + command.params['project'] = project unless project.nil? + command.params['interconnect'] = interconnect unless interconnect.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns the specified interconnect. Get a list of available interconnects by + # making a list() request. + # @param [String] project + # Project ID for this request. + # @param [String] interconnect + # Name of the interconnect to return. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Interconnect] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Interconnect] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_interconnect(project, interconnect, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/global/interconnects/{interconnect}', options) + command.response_representation = Google::Apis::ComputeV1::Interconnect::Representation + command.response_class = Google::Apis::ComputeV1::Interconnect + command.params['project'] = project unless project.nil? + command.params['interconnect'] = interconnect unless interconnect.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Creates a Interconnect in the specified project using the data included in the + # request. + # @param [String] project + # Project ID for this request. + # @param [Google::Apis::ComputeV1::Interconnect] interconnect_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_interconnect(project, interconnect_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/global/interconnects', options) + command.request_representation = Google::Apis::ComputeV1::Interconnect::Representation + command.request_object = interconnect_object + command.response_representation = Google::Apis::ComputeV1::Operation::Representation + command.response_class = Google::Apis::ComputeV1::Operation + command.params['project'] = project unless project.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of interconnect available to the specified project. + # @param [String] project + # Project ID for this request. + # @param [String] filter + # Sets a filter `expression` for filtering listed resources. Your `expression` + # must be in the format: field_name comparison_string literal_string. + # The field_name is the name of the field you want to compare. Only atomic field + # types are supported (string, number, boolean). The comparison_string must be + # either eq (equals) or ne (not equals). The literal_string is the string value + # to filter to. The literal value must be valid for the type of field you are + # filtering by (string, number, boolean). For string fields, the literal value + # is interpreted as a regular expression using RE2 syntax. The literal value + # must match the entire field. + # For example, to filter for instances that do not have a name of example- + # instance, you would use name ne example-instance. + # You can filter on nested fields. For example, you could filter on instances + # that have set the scheduling.automaticRestart field to true. Use filtering on + # nested fields to take advantage of labels to organize and search for results + # based on label values. + # To filter on multiple expressions, provide each separate expression within + # parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- + # central1-f). Multiple expressions are treated as AND expressions, meaning that + # resources must match all expressions to pass the filters. + # @param [Fixnum] max_results + # The maximum number of results per page that should be returned. If the number + # of available results is larger than maxResults, Compute Engine returns a + # nextPageToken that can be used to get the next page of results in subsequent + # list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + # @param [String] order_by + # Sorts list results by a certain order. By default, results are returned in + # alphanumerical order based on the resource name. + # You can also sort results in descending order based on the creation timestamp + # using orderBy="creationTimestamp desc". This sorts results based on the + # creationTimestamp field in reverse chronological order (newest result first). + # Use this to sort resources like operations so that the newest operation is + # returned first. + # Currently, only sorting by name or creationTimestamp desc is supported. + # @param [String] page_token + # Specifies a page token to use. Set pageToken to the nextPageToken returned by + # a previous list request to get the next page of results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::InterconnectList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::InterconnectList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_interconnects(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/global/interconnects', options) + command.response_representation = Google::Apis::ComputeV1::InterconnectList::Representation + command.response_class = Google::Apis::ComputeV1::InterconnectList + command.params['project'] = project unless project.nil? + command.query['filter'] = filter unless filter.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates the specified interconnect with the data included in the request. This + # method supports PATCH semantics and uses the JSON merge patch format and + # processing rules. + # @param [String] project + # Project ID for this request. + # @param [String] interconnect + # Name of the interconnect to update. + # @param [Google::Apis::ComputeV1::Interconnect] interconnect_object + # @param [String] request_id + # An optional request ID to identify requests. Specify a unique request ID so + # that if you must retry your request, the server will know to ignore the + # request if it has already been completed. + # For example, consider a situation where you make an initial request and the + # request times out. If you make the request again with the same request ID, the + # server can check if original operation with the same request ID was received, + # and if so, will ignore the second request. This prevents clients from + # accidentally creating duplicate commitments. + # The request ID must be a valid UUID with the exception that zero UUID is not + # supported (00000000-0000-0000-0000-000000000000). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ComputeV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ComputeV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_interconnect(project, interconnect, interconnect_object = nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, '{project}/global/interconnects/{interconnect}', options) + command.request_representation = Google::Apis::ComputeV1::Interconnect::Representation + command.request_object = interconnect_object + command.response_representation = Google::Apis::ComputeV1::Operation::Representation + command.response_class = Google::Apis::ComputeV1::Operation + command.params['project'] = project unless project.nil? + command.params['interconnect'] = interconnect unless interconnect.nil? + command.query['requestId'] = request_id unless request_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Returns the specified License resource. # @param [String] project # Project ID for this request. diff --git a/generated/google/apis/container_v1.rb b/generated/google/apis/container_v1.rb index fac84ad26..1bffd9c7a 100644 --- a/generated/google/apis/container_v1.rb +++ b/generated/google/apis/container_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-engine/ module ContainerV1 VERSION = 'V1' - REVISION = '20170922' + REVISION = '20171111' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/container_v1/classes.rb b/generated/google/apis/container_v1/classes.rb index 0c4f429f1..c2b033033 100644 --- a/generated/google/apis/container_v1/classes.rb +++ b/generated/google/apis/container_v1/classes.rb @@ -270,9 +270,7 @@ module Google # @return [Fixnum] attr_accessor :initial_node_count - # [Output only] The resource URLs of [instance - # groups](/compute/docs/instance-groups/) associated with this - # cluster. + # Deprecated. Use node_pools.instance_group_urls. # Corresponds to the JSON property `instanceGroupUrls` # @return [Array] attr_accessor :instance_group_urls @@ -1334,9 +1332,9 @@ module Google # @return [Fixnum] attr_accessor :initial_node_count - # [Output only] The resource URLs of [instance - # groups](/compute/docs/instance-groups/) associated with this - # node pool. + # [Output only] The resource URLs of the [managed instance + # groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) + # associated with this node pool. # Corresponds to the JSON property `instanceGroupUrls` # @return [Array] attr_accessor :instance_group_urls @@ -1368,7 +1366,7 @@ module Google # @return [String] attr_accessor :status_message - # [Output only] The version of the Kubernetes of this node. + # The version of the Kubernetes of this node. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version diff --git a/generated/google/apis/container_v1beta1.rb b/generated/google/apis/container_v1beta1.rb index 1f39b75bf..0e0b61b77 100644 --- a/generated/google/apis/container_v1beta1.rb +++ b/generated/google/apis/container_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/container-engine/ module ContainerV1beta1 VERSION = 'V1beta1' - REVISION = '20170922' + REVISION = '20171111' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/container_v1beta1/classes.rb b/generated/google/apis/container_v1beta1/classes.rb index 39cd21548..9c4dc74cf 100644 --- a/generated/google/apis/container_v1beta1/classes.rb +++ b/generated/google/apis/container_v1beta1/classes.rb @@ -300,9 +300,7 @@ module Google # @return [Fixnum] attr_accessor :initial_node_count - # [Output only] The resource URLs of [instance - # groups](/compute/docs/instance-groups/) associated with this - # cluster. + # Deprecated. Use node_pools.instance_group_urls. # Corresponds to the JSON property `instanceGroupUrls` # @return [Array] attr_accessor :instance_group_urls @@ -1426,9 +1424,9 @@ module Google # @return [Fixnum] attr_accessor :initial_node_count - # [Output only] The resource URLs of [instance - # groups](/compute/docs/instance-groups/) associated with this - # node pool. + # [Output only] The resource URLs of the [managed instance + # groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) + # associated with this node pool. # Corresponds to the JSON property `instanceGroupUrls` # @return [Array] attr_accessor :instance_group_urls @@ -1460,7 +1458,7 @@ module Google # @return [String] attr_accessor :status_message - # [Output only] The version of the Kubernetes of this node. + # The version of the Kubernetes of this node. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -1759,6 +1757,57 @@ module Google end end + # SetAddonsRequest sets the addons associated with the cluster. + class SetAddonsConfigRequest + include Google::Apis::Core::Hashable + + # Configuration for the addons that can be automatically spun up in the + # cluster, enabling additional functionality. + # Corresponds to the JSON property `addonsConfig` + # @return [Google::Apis::ContainerV1beta1::AddonsConfig] + attr_accessor :addons_config + + # The name of the cluster to upgrade. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `clusterId` + # @return [String] + attr_accessor :cluster_id + + # The name (project, location, cluster) of the cluster to set addons. + # Specified in the format 'projects/*/locations/*/clusters/*'. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The Google Developers Console [project ID or project + # number](https://support.google.com/cloud/answer/6158840). + # This field is deprecated, use name instead. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # The name of the Google Compute Engine + # [zone](/compute/docs/zones#available) in which the cluster + # resides. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `zone` + # @return [String] + attr_accessor :zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @addons_config = args[:addons_config] if args.key?(:addons_config) + @cluster_id = args[:cluster_id] if args.key?(:cluster_id) + @name = args[:name] if args.key?(:name) + @project_id = args[:project_id] if args.key?(:project_id) + @zone = args[:zone] if args.key?(:zone) + end + end + # SetLabelsRequest sets the Google Cloud Platform labels on a Google Container # Engine cluster, which will in turn set them for Google Compute Engine # resources used by that cluster @@ -1874,6 +1923,113 @@ module Google end end + # SetLocationsRequest sets the locations of the cluster. + class SetLocationsRequest + include Google::Apis::Core::Hashable + + # The name of the cluster to upgrade. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `clusterId` + # @return [String] + attr_accessor :cluster_id + + # The desired list of Google Compute Engine + # [locations](/compute/docs/zones#available) in which the cluster's nodes + # should be located. Changing the locations a cluster is in will result + # in nodes being either created or removed from the cluster, depending on + # whether locations are being added or removed. + # This list must always include the cluster's primary zone. + # Corresponds to the JSON property `locations` + # @return [Array] + attr_accessor :locations + + # The name (project, location, cluster) of the cluster to set locations. + # Specified in the format 'projects/*/locations/*/clusters/*'. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The Google Developers Console [project ID or project + # number](https://support.google.com/cloud/answer/6158840). + # This field is deprecated, use name instead. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # The name of the Google Compute Engine + # [zone](/compute/docs/zones#available) in which the cluster + # resides. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `zone` + # @return [String] + attr_accessor :zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cluster_id = args[:cluster_id] if args.key?(:cluster_id) + @locations = args[:locations] if args.key?(:locations) + @name = args[:name] if args.key?(:name) + @project_id = args[:project_id] if args.key?(:project_id) + @zone = args[:zone] if args.key?(:zone) + end + end + + # SetLoggingServiceRequest sets the logging service of a cluster. + class SetLoggingServiceRequest + include Google::Apis::Core::Hashable + + # The name of the cluster to upgrade. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `clusterId` + # @return [String] + attr_accessor :cluster_id + + # The logging service the cluster should use to write metrics. + # Currently available options: + # * "logging.googleapis.com" - the Google Cloud Logging service + # * "none" - no metrics will be exported from the cluster + # Corresponds to the JSON property `loggingService` + # @return [String] + attr_accessor :logging_service + + # The name (project, location, cluster) of the cluster to set logging. + # Specified in the format 'projects/*/locations/*/clusters/*'. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The Google Developers Console [project ID or project + # number](https://support.google.com/cloud/answer/6158840). + # This field is deprecated, use name instead. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # The name of the Google Compute Engine + # [zone](/compute/docs/zones#available) in which the cluster + # resides. + # Corresponds to the JSON property `zone` + # @return [String] + attr_accessor :zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cluster_id = args[:cluster_id] if args.key?(:cluster_id) + @logging_service = args[:logging_service] if args.key?(:logging_service) + @name = args[:name] if args.key?(:name) + @project_id = args[:project_id] if args.key?(:project_id) + @zone = args[:zone] if args.key?(:zone) + end + end + # SetMaintenancePolicyRequest sets the maintenance policy for a cluster. class SetMaintenancePolicyRequest include Google::Apis::Core::Hashable @@ -1980,6 +2136,59 @@ module Google end end + # SetMonitoringServiceRequest sets the monitoring service of a cluster. + class SetMonitoringServiceRequest + include Google::Apis::Core::Hashable + + # The name of the cluster to upgrade. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `clusterId` + # @return [String] + attr_accessor :cluster_id + + # The monitoring service the cluster should use to write metrics. + # Currently available options: + # * "monitoring.googleapis.com" - the Google Cloud Monitoring service + # * "none" - no metrics will be exported from the cluster + # Corresponds to the JSON property `monitoringService` + # @return [String] + attr_accessor :monitoring_service + + # The name (project, location, cluster) of the cluster to set monitoring. + # Specified in the format 'projects/*/locations/*/clusters/*'. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The Google Developers Console [project ID or project + # number](https://support.google.com/cloud/answer/6158840). + # This field is deprecated, use name instead. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # The name of the Google Compute Engine + # [zone](/compute/docs/zones#available) in which the cluster + # resides. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `zone` + # @return [String] + attr_accessor :zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cluster_id = args[:cluster_id] if args.key?(:cluster_id) + @monitoring_service = args[:monitoring_service] if args.key?(:monitoring_service) + @name = args[:name] if args.key?(:name) + @project_id = args[:project_id] if args.key?(:project_id) + @zone = args[:zone] if args.key?(:zone) + end + end + # SetNetworkPolicyRequest enables/disables network policy for a cluster. class SetNetworkPolicyRequest include Google::Apis::Core::Hashable @@ -2032,6 +2241,65 @@ module Google end end + # SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool. + class SetNodePoolAutoscalingRequest + include Google::Apis::Core::Hashable + + # NodePoolAutoscaling contains information required by cluster autoscaler to + # adjust the size of the node pool to the current cluster usage. + # Corresponds to the JSON property `autoscaling` + # @return [Google::Apis::ContainerV1beta1::NodePoolAutoscaling] + attr_accessor :autoscaling + + # The name of the cluster to upgrade. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `clusterId` + # @return [String] + attr_accessor :cluster_id + + # The name (project, location, cluster, node pool) of the node pool to set + # autoscaler settings. Specified in the format + # 'projects/*/locations/*/clusters/*/nodePools/*'. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The name of the node pool to upgrade. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `nodePoolId` + # @return [String] + attr_accessor :node_pool_id + + # The Google Developers Console [project ID or project + # number](https://support.google.com/cloud/answer/6158840). + # This field is deprecated, use name instead. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # The name of the Google Compute Engine + # [zone](/compute/docs/zones#available) in which the cluster + # resides. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `zone` + # @return [String] + attr_accessor :zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @autoscaling = args[:autoscaling] if args.key?(:autoscaling) + @cluster_id = args[:cluster_id] if args.key?(:cluster_id) + @name = args[:name] if args.key?(:name) + @node_pool_id = args[:node_pool_id] if args.key?(:node_pool_id) + @project_id = args[:project_id] if args.key?(:project_id) + @zone = args[:zone] if args.key?(:zone) + end + end + # SetNodePoolManagementRequest sets the node management properties of a node # pool. class SetNodePoolManagementRequest @@ -2188,6 +2456,122 @@ module Google @zone = args[:zone] if args.key?(:zone) end end + + # UpdateMasterRequest updates the master of the cluster. + class UpdateMasterRequest + include Google::Apis::Core::Hashable + + # The name of the cluster to upgrade. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `clusterId` + # @return [String] + attr_accessor :cluster_id + + # The Kubernetes version to change the master to. The only valid value is the + # latest supported version. Use "-" to have the server automatically select + # the latest version. + # Corresponds to the JSON property `masterVersion` + # @return [String] + attr_accessor :master_version + + # The name (project, location, cluster) of the cluster to update. + # Specified in the format 'projects/*/locations/*/clusters/*'. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The Google Developers Console [project ID or project + # number](https://support.google.com/cloud/answer/6158840). + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # The name of the Google Compute Engine + # [zone](/compute/docs/zones#available) in which the cluster + # resides. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `zone` + # @return [String] + attr_accessor :zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cluster_id = args[:cluster_id] if args.key?(:cluster_id) + @master_version = args[:master_version] if args.key?(:master_version) + @name = args[:name] if args.key?(:name) + @project_id = args[:project_id] if args.key?(:project_id) + @zone = args[:zone] if args.key?(:zone) + end + end + + # SetNodePoolVersionRequest updates the version of a node pool. + class UpdateNodePoolRequest + include Google::Apis::Core::Hashable + + # The name of the cluster to upgrade. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `clusterId` + # @return [String] + attr_accessor :cluster_id + + # The desired image type for the node pool. + # Corresponds to the JSON property `imageType` + # @return [String] + attr_accessor :image_type + + # The name (project, location, cluster, node pool) of the node pool to update. + # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The name of the node pool to upgrade. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `nodePoolId` + # @return [String] + attr_accessor :node_pool_id + + # The Kubernetes version to change the nodes to (typically an + # upgrade). Use `-` to upgrade to the latest version supported by + # the server. + # Corresponds to the JSON property `nodeVersion` + # @return [String] + attr_accessor :node_version + + # The Google Developers Console [project ID or project + # number](https://support.google.com/cloud/answer/6158840). + # This field is deprecated, use name instead. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + # The name of the Google Compute Engine + # [zone](/compute/docs/zones#available) in which the cluster + # resides. + # This field is deprecated, use name instead. + # Corresponds to the JSON property `zone` + # @return [String] + attr_accessor :zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cluster_id = args[:cluster_id] if args.key?(:cluster_id) + @image_type = args[:image_type] if args.key?(:image_type) + @name = args[:name] if args.key?(:name) + @node_pool_id = args[:node_pool_id] if args.key?(:node_pool_id) + @node_version = args[:node_version] if args.key?(:node_version) + @project_id = args[:project_id] if args.key?(:project_id) + @zone = args[:zone] if args.key?(:zone) + end + end end end end diff --git a/generated/google/apis/container_v1beta1/representations.rb b/generated/google/apis/container_v1beta1/representations.rb index 9435d1a26..b72563fe2 100644 --- a/generated/google/apis/container_v1beta1/representations.rb +++ b/generated/google/apis/container_v1beta1/representations.rb @@ -232,6 +232,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SetAddonsConfigRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SetLabelsRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -244,6 +250,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SetLocationsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SetLoggingServiceRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SetMaintenancePolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -256,12 +274,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SetMonitoringServiceRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SetNetworkPolicyRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class SetNodePoolAutoscalingRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SetNodePoolManagementRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -280,6 +310,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class UpdateMasterRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpdateNodePoolRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AcceleratorConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -682,6 +724,18 @@ module Google end end + class SetAddonsConfigRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :addons_config, as: 'addonsConfig', class: Google::Apis::ContainerV1beta1::AddonsConfig, decorator: Google::Apis::ContainerV1beta1::AddonsConfig::Representation + + property :cluster_id, as: 'clusterId' + property :name, as: 'name' + property :project_id, as: 'projectId' + property :zone, as: 'zone' + end + end + class SetLabelsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -705,6 +759,28 @@ module Google end end + class SetLocationsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cluster_id, as: 'clusterId' + collection :locations, as: 'locations' + property :name, as: 'name' + property :project_id, as: 'projectId' + property :zone, as: 'zone' + end + end + + class SetLoggingServiceRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cluster_id, as: 'clusterId' + property :logging_service, as: 'loggingService' + property :name, as: 'name' + property :project_id, as: 'projectId' + property :zone, as: 'zone' + end + end + class SetMaintenancePolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -730,6 +806,17 @@ module Google end end + class SetMonitoringServiceRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cluster_id, as: 'clusterId' + property :monitoring_service, as: 'monitoringService' + property :name, as: 'name' + property :project_id, as: 'projectId' + property :zone, as: 'zone' + end + end + class SetNetworkPolicyRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -742,6 +829,19 @@ module Google end end + class SetNodePoolAutoscalingRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :autoscaling, as: 'autoscaling', class: Google::Apis::ContainerV1beta1::NodePoolAutoscaling, decorator: Google::Apis::ContainerV1beta1::NodePoolAutoscaling::Representation + + property :cluster_id, as: 'clusterId' + property :name, as: 'name' + property :node_pool_id, as: 'nodePoolId' + property :project_id, as: 'projectId' + property :zone, as: 'zone' + end + end + class SetNodePoolManagementRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -776,6 +876,30 @@ module Google property :zone, as: 'zone' end end + + class UpdateMasterRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cluster_id, as: 'clusterId' + property :master_version, as: 'masterVersion' + property :name, as: 'name' + property :project_id, as: 'projectId' + property :zone, as: 'zone' + end + end + + class UpdateNodePoolRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cluster_id, as: 'clusterId' + property :image_type, as: 'imageType' + property :name, as: 'name' + property :node_pool_id, as: 'nodePoolId' + property :node_version, as: 'nodeVersion' + property :project_id, as: 'projectId' + property :zone, as: 'zone' + end + end end end end diff --git a/generated/google/apis/container_v1beta1/service.rb b/generated/google/apis/container_v1beta1/service.rb index 65a639bad..e12d98c86 100644 --- a/generated/google/apis/container_v1beta1/service.rb +++ b/generated/google/apis/container_v1beta1/service.rb @@ -309,6 +309,40 @@ module Google execute_or_queue_command(command, &block) end + # Sets the addons of a specific cluster. + # @param [String] name + # The name (project, location, cluster) of the cluster to set addons. + # Specified in the format 'projects/*/locations/*/clusters/*'. + # @param [Google::Apis::ContainerV1beta1::SetAddonsConfigRequest] set_addons_config_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContainerV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContainerV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_cluster_addons_config(name, set_addons_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:setAddons', options) + command.request_representation = Google::Apis::ContainerV1beta1::SetAddonsConfigRequest::Representation + command.request_object = set_addons_config_request_object + command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation + command.response_class = Google::Apis::ContainerV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Enables or disables the ABAC authorization mechanism on a cluster. # @param [String] name # The name (project, location, cluster id) of the cluster to set legacy abac. @@ -343,6 +377,74 @@ module Google execute_or_queue_command(command, &block) end + # Sets the locations of a specific cluster. + # @param [String] name + # The name (project, location, cluster) of the cluster to set locations. + # Specified in the format 'projects/*/locations/*/clusters/*'. + # @param [Google::Apis::ContainerV1beta1::SetLocationsRequest] set_locations_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContainerV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContainerV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_cluster_locations(name, set_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:setLocations', options) + command.request_representation = Google::Apis::ContainerV1beta1::SetLocationsRequest::Representation + command.request_object = set_locations_request_object + command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation + command.response_class = Google::Apis::ContainerV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the logging service of a specific cluster. + # @param [String] name + # The name (project, location, cluster) of the cluster to set logging. + # Specified in the format 'projects/*/locations/*/clusters/*'. + # @param [Google::Apis::ContainerV1beta1::SetLoggingServiceRequest] set_logging_service_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContainerV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContainerV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_cluster_logging_service(name, set_logging_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:setLogging', options) + command.request_representation = Google::Apis::ContainerV1beta1::SetLoggingServiceRequest::Representation + command.request_object = set_logging_service_request_object + command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation + command.response_class = Google::Apis::ContainerV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Sets the maintenance policy for a cluster. # @param [String] name # The name (project, location, cluster id) of the cluster to set maintenance @@ -415,6 +517,40 @@ module Google execute_or_queue_command(command, &block) end + # Sets the monitoring service of a specific cluster. + # @param [String] name + # The name (project, location, cluster) of the cluster to set monitoring. + # Specified in the format 'projects/*/locations/*/clusters/*'. + # @param [Google::Apis::ContainerV1beta1::SetMonitoringServiceRequest] set_monitoring_service_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContainerV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContainerV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_cluster_monitoring_service(name, set_monitoring_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:setMonitoring', options) + command.request_representation = Google::Apis::ContainerV1beta1::SetMonitoringServiceRequest::Representation + command.request_object = set_monitoring_service_request_object + command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation + command.response_class = Google::Apis::ContainerV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Enables/Disables Network Policy for a cluster. # @param [String] name # The name (project, location, cluster id) of the cluster to set networking @@ -552,6 +688,40 @@ module Google execute_or_queue_command(command, &block) end + # Updates the master of a specific cluster. + # @param [String] name + # The name (project, location, cluster) of the cluster to update. + # Specified in the format 'projects/*/locations/*/clusters/*'. + # @param [Google::Apis::ContainerV1beta1::UpdateMasterRequest] update_master_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContainerV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContainerV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_cluster_master(name, update_master_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:updateMaster', options) + command.request_representation = Google::Apis::ContainerV1beta1::UpdateMasterRequest::Representation + command.request_object = update_master_request_object + command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation + command.response_class = Google::Apis::ContainerV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a node pool for a cluster. # @param [String] parent # The parent (project, location, cluster id) where the node pool will be created. @@ -768,6 +938,41 @@ module Google execute_or_queue_command(command, &block) end + # Sets the autoscaling settings of a specific node pool. + # @param [String] name + # The name (project, location, cluster, node pool) of the node pool to set + # autoscaler settings. Specified in the format + # 'projects/*/locations/*/clusters/*/nodePools/*'. + # @param [Google::Apis::ContainerV1beta1::SetNodePoolAutoscalingRequest] set_node_pool_autoscaling_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContainerV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContainerV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_project_location_cluster_node_pool_autoscaling(name, set_node_pool_autoscaling_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:setAutoscaling', options) + command.request_representation = Google::Apis::ContainerV1beta1::SetNodePoolAutoscalingRequest::Representation + command.request_object = set_node_pool_autoscaling_request_object + command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation + command.response_class = Google::Apis::ContainerV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Sets the NodeManagement options for a node pool. # @param [String] name # The name (project, location, cluster, node pool id) of the node pool to set @@ -803,6 +1008,40 @@ module Google execute_or_queue_command(command, &block) end + # Updates the version and/or iamge type of a specific node pool. + # @param [String] name + # The name (project, location, cluster, node pool) of the node pool to update. + # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. + # @param [Google::Apis::ContainerV1beta1::UpdateNodePoolRequest] update_node_pool_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContainerV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContainerV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_project_location_cluster_node_pool(name, update_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1beta1/{+name}', options) + command.request_representation = Google::Apis::ContainerV1beta1::UpdateNodePoolRequest::Representation + command.request_object = update_node_pool_request_object + command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation + command.response_class = Google::Apis::ContainerV1beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Cancels the specified operation. # @param [String] name # The name (project, location, operation id) of the operation to cancel. @@ -966,6 +1205,51 @@ module Google execute_or_queue_command(command, &block) end + # Sets the addons of a specific cluster. + # @param [String] project_id + # The Google Developers Console [project ID or project + # number](https://support.google.com/cloud/answer/6158840). + # This field is deprecated, use name instead. + # @param [String] zone + # The name of the Google Compute Engine + # [zone](/compute/docs/zones#available) in which the cluster + # resides. + # This field is deprecated, use name instead. + # @param [String] cluster_id + # The name of the cluster to upgrade. + # This field is deprecated, use name instead. + # @param [Google::Apis::ContainerV1beta1::SetAddonsConfigRequest] set_addons_config_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContainerV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContainerV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def addons_project_zone_cluster(project_id, zone, cluster_id, set_addons_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons', options) + command.request_representation = Google::Apis::ContainerV1beta1::SetAddonsConfigRequest::Representation + command.request_object = set_addons_config_request_object + command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation + command.response_class = Google::Apis::ContainerV1beta1::Operation + command.params['projectId'] = project_id unless project_id.nil? + command.params['zone'] = zone unless zone.nil? + command.params['clusterId'] = cluster_id unless cluster_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Completes master IP rotation. # @param [String] project_id # The Google Developers Console [project ID or project @@ -1248,6 +1532,184 @@ module Google execute_or_queue_command(command, &block) end + # Sets the locations of a specific cluster. + # @param [String] project_id + # The Google Developers Console [project ID or project + # number](https://support.google.com/cloud/answer/6158840). + # This field is deprecated, use name instead. + # @param [String] zone + # The name of the Google Compute Engine + # [zone](/compute/docs/zones#available) in which the cluster + # resides. + # This field is deprecated, use name instead. + # @param [String] cluster_id + # The name of the cluster to upgrade. + # This field is deprecated, use name instead. + # @param [Google::Apis::ContainerV1beta1::SetLocationsRequest] set_locations_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContainerV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContainerV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def locations_project_zone_cluster(project_id, zone, cluster_id, set_locations_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations', options) + command.request_representation = Google::Apis::ContainerV1beta1::SetLocationsRequest::Representation + command.request_object = set_locations_request_object + command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation + command.response_class = Google::Apis::ContainerV1beta1::Operation + command.params['projectId'] = project_id unless project_id.nil? + command.params['zone'] = zone unless zone.nil? + command.params['clusterId'] = cluster_id unless cluster_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the logging service of a specific cluster. + # @param [String] project_id + # The Google Developers Console [project ID or project + # number](https://support.google.com/cloud/answer/6158840). + # This field is deprecated, use name instead. + # @param [String] zone + # The name of the Google Compute Engine + # [zone](/compute/docs/zones#available) in which the cluster + # resides. + # @param [String] cluster_id + # The name of the cluster to upgrade. + # This field is deprecated, use name instead. + # @param [Google::Apis::ContainerV1beta1::SetLoggingServiceRequest] set_logging_service_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContainerV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContainerV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def logging_project_zone_cluster(project_id, zone, cluster_id, set_logging_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging', options) + command.request_representation = Google::Apis::ContainerV1beta1::SetLoggingServiceRequest::Representation + command.request_object = set_logging_service_request_object + command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation + command.response_class = Google::Apis::ContainerV1beta1::Operation + command.params['projectId'] = project_id unless project_id.nil? + command.params['zone'] = zone unless zone.nil? + command.params['clusterId'] = cluster_id unless cluster_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the master of a specific cluster. + # @param [String] project_id + # The Google Developers Console [project ID or project + # number](https://support.google.com/cloud/answer/6158840). + # @param [String] zone + # The name of the Google Compute Engine + # [zone](/compute/docs/zones#available) in which the cluster + # resides. + # This field is deprecated, use name instead. + # @param [String] cluster_id + # The name of the cluster to upgrade. + # This field is deprecated, use name instead. + # @param [Google::Apis::ContainerV1beta1::UpdateMasterRequest] update_master_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContainerV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContainerV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def master_project_zone_cluster(project_id, zone, cluster_id, update_master_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master', options) + command.request_representation = Google::Apis::ContainerV1beta1::UpdateMasterRequest::Representation + command.request_object = update_master_request_object + command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation + command.response_class = Google::Apis::ContainerV1beta1::Operation + command.params['projectId'] = project_id unless project_id.nil? + command.params['zone'] = zone unless zone.nil? + command.params['clusterId'] = cluster_id unless cluster_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Sets the monitoring service of a specific cluster. + # @param [String] project_id + # The Google Developers Console [project ID or project + # number](https://support.google.com/cloud/answer/6158840). + # This field is deprecated, use name instead. + # @param [String] zone + # The name of the Google Compute Engine + # [zone](/compute/docs/zones#available) in which the cluster + # resides. + # This field is deprecated, use name instead. + # @param [String] cluster_id + # The name of the cluster to upgrade. + # This field is deprecated, use name instead. + # @param [Google::Apis::ContainerV1beta1::SetMonitoringServiceRequest] set_monitoring_service_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContainerV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContainerV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def monitoring_project_zone_cluster(project_id, zone, cluster_id, set_monitoring_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring', options) + command.request_representation = Google::Apis::ContainerV1beta1::SetMonitoringServiceRequest::Representation + command.request_object = set_monitoring_service_request_object + command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation + command.response_class = Google::Apis::ContainerV1beta1::Operation + command.params['projectId'] = project_id unless project_id.nil? + command.params['zone'] = zone unless zone.nil? + command.params['clusterId'] = cluster_id unless cluster_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Sets labels on a cluster. # @param [String] project_id # The Google Developers Console [project ID or project @@ -1518,6 +1980,55 @@ module Google execute_or_queue_command(command, &block) end + # Sets the autoscaling settings of a specific node pool. + # @param [String] project_id + # The Google Developers Console [project ID or project + # number](https://support.google.com/cloud/answer/6158840). + # This field is deprecated, use name instead. + # @param [String] zone + # The name of the Google Compute Engine + # [zone](/compute/docs/zones#available) in which the cluster + # resides. + # This field is deprecated, use name instead. + # @param [String] cluster_id + # The name of the cluster to upgrade. + # This field is deprecated, use name instead. + # @param [String] node_pool_id + # The name of the node pool to upgrade. + # This field is deprecated, use name instead. + # @param [Google::Apis::ContainerV1beta1::SetNodePoolAutoscalingRequest] set_node_pool_autoscaling_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContainerV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContainerV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def autoscaling_project_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, set_node_pool_autoscaling_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling', options) + command.request_representation = Google::Apis::ContainerV1beta1::SetNodePoolAutoscalingRequest::Representation + command.request_object = set_node_pool_autoscaling_request_object + command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation + command.response_class = Google::Apis::ContainerV1beta1::Operation + command.params['projectId'] = project_id unless project_id.nil? + command.params['zone'] = zone unless zone.nil? + command.params['clusterId'] = cluster_id unless cluster_id.nil? + command.params['nodePoolId'] = node_pool_id unless node_pool_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a node pool for a cluster. # @param [String] project_id # The Google Developers Console [project ID or project @@ -1808,6 +2319,55 @@ module Google execute_or_queue_command(command, &block) end + # Updates the version and/or iamge type of a specific node pool. + # @param [String] project_id + # The Google Developers Console [project ID or project + # number](https://support.google.com/cloud/answer/6158840). + # This field is deprecated, use name instead. + # @param [String] zone + # The name of the Google Compute Engine + # [zone](/compute/docs/zones#available) in which the cluster + # resides. + # This field is deprecated, use name instead. + # @param [String] cluster_id + # The name of the cluster to upgrade. + # This field is deprecated, use name instead. + # @param [String] node_pool_id + # The name of the node pool to upgrade. + # This field is deprecated, use name instead. + # @param [Google::Apis::ContainerV1beta1::UpdateNodePoolRequest] update_node_pool_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ContainerV1beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ContainerV1beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_project_zone_cluster_node_pool(project_id, zone, cluster_id, node_pool_id, update_node_pool_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update', options) + command.request_representation = Google::Apis::ContainerV1beta1::UpdateNodePoolRequest::Representation + command.request_object = update_node_pool_request_object + command.response_representation = Google::Apis::ContainerV1beta1::Operation::Representation + command.response_class = Google::Apis::ContainerV1beta1::Operation + command.params['projectId'] = project_id unless project_id.nil? + command.params['zone'] = zone unless zone.nil? + command.params['clusterId'] = cluster_id unless cluster_id.nil? + command.params['nodePoolId'] = node_pool_id unless node_pool_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Cancels the specified operation. # @param [String] project_id # The Google Developers Console [project ID or project diff --git a/generated/google/apis/content_v2.rb b/generated/google/apis/content_v2.rb index 5303aaccf..b969561b7 100644 --- a/generated/google/apis/content_v2.rb +++ b/generated/google/apis/content_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/shopping-content module ContentV2 VERSION = 'V2' - REVISION = '20170928' + REVISION = '20171124' # Manage your product listings and accounts for Google Shopping AUTH_CONTENT = 'https://www.googleapis.com/auth/content' diff --git a/generated/google/apis/content_v2/classes.rb b/generated/google/apis/content_v2/classes.rb index 0a4cc2364..f34139609 100644 --- a/generated/google/apis/content_v2/classes.rb +++ b/generated/google/apis/content_v2/classes.rb @@ -41,6 +41,12 @@ module Google # @return [Array] attr_accessor :adwords_links + # The GMB account which is linked or in the process of being linked with the + # Merchant Center accounnt. + # Corresponds to the JSON property `googleMyBusinessLink` + # @return [Google::Apis::ContentV2::AccountGoogleMyBusinessLink] + attr_accessor :google_my_business_link + # Merchant Center account ID. # Corresponds to the JSON property `id` # @return [Fixnum] @@ -95,6 +101,7 @@ module Google def update!(**args) @adult_content = args[:adult_content] if args.key?(:adult_content) @adwords_links = args[:adwords_links] if args.key?(:adwords_links) + @google_my_business_link = args[:google_my_business_link] if args.key?(:google_my_business_link) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @@ -139,6 +146,31 @@ module Google end end + # + class AccountGoogleMyBusinessLink + include Google::Apis::Core::Hashable + + # The GMB email address. + # Corresponds to the JSON property `gmbEmail` + # @return [String] + attr_accessor :gmb_email + + # Status of the link between this Merchant Center account and the GMB account. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gmb_email = args[:gmb_email] if args.key?(:gmb_email) + @status = args[:status] if args.key?(:status) + end + end + # class AccountIdentifier include Google::Apis::Core::Hashable @@ -1136,7 +1168,7 @@ module Google # @return [String] attr_accessor :attribute_language - # [DEPRECATED] Please use target.language instead. The two-letter ISO 639-1 + # [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 # language of the items in the feed. Must be a valid language for targetCountry. # Corresponds to the JSON property `contentLanguage` # @return [String] @@ -1171,7 +1203,7 @@ module Google # @return [Fixnum] attr_accessor :id - # [DEPRECATED] Please use target.includedDestination instead. The list of + # [DEPRECATED] Please use targets[].includedDestinations instead. The list of # intended destinations (corresponds to checked check boxes in Merchant Center). # Corresponds to the JSON property `intendedDestinations` # @return [Array] @@ -1188,9 +1220,9 @@ module Google # @return [String] attr_accessor :name - # [DEPRECATED] Please use target.country instead. The country where the items in - # the feed will be included in the search index, represented as a CLDR territory - # code. + # [DEPRECATED] Please use targets[].country instead. The country where the items + # in the feed will be included in the search index, represented as a CLDR + # territory code. # Corresponds to the JSON property `targetCountry` # @return [String] attr_accessor :target_country @@ -1946,18 +1978,20 @@ module Google # @return [Array] attr_accessor :postal_code_group_names - # be "infinity". For example [`"value": "10", "currency": "USD"`, `"value": "500" - # , "currency": "USD"`, `"value": "infinity", "currency": "USD"`] represents the + # A list of inclusive order price upper bounds. The last price's value can be " + # infinity". For example [`"value": "10", "currency": "USD"`, `"value": "500", " + # currency": "USD"`, `"value": "infinity", "currency": "USD"`] represents the # headers "<= $10", " $500". All prices within a service must have the same # currency. Must be non-empty. Can only be set if all other fields are not set. # Corresponds to the JSON property `prices` # @return [Array] attr_accessor :prices - # be "infinity". For example [`"value": "10", "unit": "kg"`, `"value": "50", " - # unit": "kg"`, `"value": "infinity", "unit": "kg"`] represents the headers "<= - # 10kg", " 50kg". All weights within a service must have the same unit. Must be - # non-empty. Can only be set if all other fields are not set. + # A list of inclusive order weight upper bounds. The last weight's value can be " + # infinity". For example [`"value": "10", "unit": "kg"`, `"value": "50", "unit": + # "kg"`, `"value": "infinity", "unit": "kg"`] represents the headers "<= 10kg", " + # 50kg". All weights within a service must have the same unit. Must be non- + # empty. Can only be set if all other fields are not set. # Corresponds to the JSON property `weights` # @return [Array] attr_accessor :weights @@ -2700,11 +2734,6 @@ module Google # @return [Array] attr_accessor :cancellations - # The channel type of the order: "purchaseOnGoogle" or "googleExpress". - # Corresponds to the JSON property `channelType` - # @return [String] - attr_accessor :channel_type - # The id of the line item. # Corresponds to the JSON property `id` # @return [String] @@ -2779,7 +2808,6 @@ module Google # Update properties of this object def update!(**args) @cancellations = args[:cancellations] if args.key?(:cancellations) - @channel_type = args[:channel_type] if args.key?(:channel_type) @id = args[:id] if args.key?(:id) @price = args[:price] if args.key?(:price) @product = args[:product] if args.key?(:product) @@ -3286,26 +3314,20 @@ module Google # Acceptable values are: # - "gsx" # - "ups" - # - "united parcel service" # - "usps" - # - "united states postal service" # - "fedex" # - "dhl" # - "ecourier" # - "cxt" # - "google" - # - "on trac" # - "ontrac" - # - "on-trac" - # - "on_trac" - # - "delvic" + # - "emsy" + # - "ont" + # - "deliv" # - "dynamex" # - "lasership" - # - "smartpost" - # - "fedex smartpost" # - "mpx" # - "uds" - # - "united delivery service" # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -3361,11 +3383,18 @@ module Google class OrderShipmentLineItemShipment include Google::Apis::Core::Hashable - # The id of the line item that is shipped. + # The id of the line item that is shipped. Either lineItemId or productId is + # required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id + # The ID of the product to ship. This is the REST ID used in the products + # service. Either lineItemId or productId is required. + # Corresponds to the JSON property `productId` + # @return [String] + attr_accessor :product_id + # The quantity that is shipped. # Corresponds to the JSON property `quantity` # @return [Fixnum] @@ -3378,6 +3407,7 @@ module Google # Update properties of this object def update!(**args) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) + @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) end end @@ -3458,7 +3488,19 @@ module Google # @return [Google::Apis::ContentV2::Price] attr_accessor :amount - # The ID of the line item to cancel. + # Amount to refund for the cancelation. Optional. If not set, Google will + # calculate the default based on the price and tax of the items involved. The + # amount must not be larger than the net amount left on the order. + # Corresponds to the JSON property `amountPretax` + # @return [Google::Apis::ContentV2::Price] + attr_accessor :amount_pretax + + # Tax amount that correspond to cancellation amount in amountPretax. + # Corresponds to the JSON property `amountTax` + # @return [Google::Apis::ContentV2::Price] + attr_accessor :amount_tax + + # The ID of the line item to cancel. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id @@ -3468,6 +3510,12 @@ module Google # @return [String] attr_accessor :operation_id + # The ID of the product to cancel. This is the REST ID used in the products + # service. Either lineItemId or productId is required. + # Corresponds to the JSON property `productId` + # @return [String] + attr_accessor :product_id + # The quantity to cancel. # Corresponds to the JSON property `quantity` # @return [Fixnum] @@ -3490,8 +3538,11 @@ module Google # Update properties of this object def update!(**args) @amount = args[:amount] if args.key?(:amount) + @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) + @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @operation_id = args[:operation_id] if args.key?(:operation_id) + @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) @@ -3776,11 +3827,29 @@ module Google # @return [Google::Apis::ContentV2::Price] attr_accessor :amount - # The ID of the line item to cancel. + # Amount to refund for the cancelation. Optional. If not set, Google will + # calculate the default based on the price and tax of the items involved. The + # amount must not be larger than the net amount left on the order. + # Corresponds to the JSON property `amountPretax` + # @return [Google::Apis::ContentV2::Price] + attr_accessor :amount_pretax + + # Tax amount that correspond to cancellation amount in amountPretax. + # Corresponds to the JSON property `amountTax` + # @return [Google::Apis::ContentV2::Price] + attr_accessor :amount_tax + + # The ID of the line item to cancel. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id + # The ID of the product to cancel. This is the REST ID used in the products + # service. Either lineItemId or productId is required. + # Corresponds to the JSON property `productId` + # @return [String] + attr_accessor :product_id + # The quantity to cancel. # Corresponds to the JSON property `quantity` # @return [Fixnum] @@ -3803,7 +3872,10 @@ module Google # Update properties of this object def update!(**args) @amount = args[:amount] if args.key?(:amount) + @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) + @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) + @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) @@ -3819,6 +3891,17 @@ module Google # @return [Google::Apis::ContentV2::Price] attr_accessor :amount + # The amount that is refunded. Either amount or amountPretax and amountTax + # should be filled. + # Corresponds to the JSON property `amountPretax` + # @return [Google::Apis::ContentV2::Price] + attr_accessor :amount_pretax + + # Tax amount that correspond to refund amount in amountPretax. + # Corresponds to the JSON property `amountTax` + # @return [Google::Apis::ContentV2::Price] + attr_accessor :amount_tax + # The reason for the refund. # Corresponds to the JSON property `reason` # @return [String] @@ -3836,6 +3919,8 @@ module Google # Update properties of this object def update!(**args) @amount = args[:amount] if args.key?(:amount) + @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) + @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end @@ -3845,11 +3930,17 @@ module Google class OrdersCustomBatchRequestEntryReturnLineItem include Google::Apis::Core::Hashable - # The ID of the line item to return. + # The ID of the line item to return. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id + # The ID of the product to return. This is the REST ID used in the products + # service. Either lineItemId or productId is required. + # Corresponds to the JSON property `productId` + # @return [String] + attr_accessor :product_id + # The quantity to return. # Corresponds to the JSON property `quantity` # @return [Fixnum] @@ -3872,6 +3963,7 @@ module Google # Update properties of this object def update!(**args) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) + @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) @@ -4159,6 +4251,17 @@ module Google # @return [Google::Apis::ContentV2::Price] attr_accessor :amount + # The amount that is refunded. Either amount or amountPretax and amountTax + # should be filled. + # Corresponds to the JSON property `amountPretax` + # @return [Google::Apis::ContentV2::Price] + attr_accessor :amount_pretax + + # Tax amount that correspond to refund amount in amountPretax. + # Corresponds to the JSON property `amountTax` + # @return [Google::Apis::ContentV2::Price] + attr_accessor :amount_tax + # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] @@ -4181,6 +4284,8 @@ module Google # Update properties of this object def update!(**args) @amount = args[:amount] if args.key?(:amount) + @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) + @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @operation_id = args[:operation_id] if args.key?(:operation_id) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) @@ -4217,7 +4322,7 @@ module Google class OrdersReturnLineItemRequest include Google::Apis::Core::Hashable - # The ID of the line item to return. + # The ID of the line item to return. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id @@ -4227,6 +4332,12 @@ module Google # @return [String] attr_accessor :operation_id + # The ID of the product to return. This is the REST ID used in the products + # service. Either lineItemId or productId is required. + # Corresponds to the JSON property `productId` + # @return [String] + attr_accessor :product_id + # The quantity to return. # Corresponds to the JSON property `quantity` # @return [Fixnum] @@ -4250,6 +4361,7 @@ module Google def update!(**args) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @operation_id = args[:operation_id] if args.key?(:operation_id) + @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) @@ -4755,7 +4867,10 @@ module Google # @return [String] attr_accessor :gtin - # The REST id of the product. + # The REST id of the product. Content API methods that operate on products take + # this as their productId parameter. + # The REST id for a product is of the form channel:contentLanguage:targetCountry: + # offerId. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -4836,10 +4951,12 @@ module Google # @return [Fixnum] attr_accessor :multipack - # An identifier of the item. Leading and trailing whitespaces are stripped and - # multiple whitespaces are replaced by a single whitespace upon submission. Only - # valid unicode characters are accepted. See the products feed specification for - # details. + # A unique identifier for the item. Leading and trailing whitespaces are + # stripped and multiple whitespaces are replaced by a single whitespace upon + # submission. Only valid unicode characters are accepted. See the products feed + # specification for details. + # Note: Content API methods that operate on products take the REST id of the + # product, not this identifier. # Corresponds to the JSON property `offerId` # @return [String] attr_accessor :offer_id @@ -6280,6 +6397,12 @@ module Google # @return [Array] attr_accessor :line_items + # Determines if test order must be pulled by merchant or pushed to merchant via + # push integration. + # Corresponds to the JSON property `notificationMode` + # @return [String] + attr_accessor :notification_mode + # The details of the payment method. # Corresponds to the JSON property `paymentMethod` # @return [Google::Apis::ContentV2::TestOrderPaymentMethod] @@ -6320,6 +6443,7 @@ module Google @customer = args[:customer] if args.key?(:customer) @kind = args[:kind] if args.key?(:kind) @line_items = args[:line_items] if args.key?(:line_items) + @notification_mode = args[:notification_mode] if args.key?(:notification_mode) @payment_method = args[:payment_method] if args.key?(:payment_method) @predefined_delivery_address = args[:predefined_delivery_address] if args.key?(:predefined_delivery_address) @promotions = args[:promotions] if args.key?(:promotions) diff --git a/generated/google/apis/content_v2/representations.rb b/generated/google/apis/content_v2/representations.rb index 334534228..c50164943 100644 --- a/generated/google/apis/content_v2/representations.rb +++ b/generated/google/apis/content_v2/representations.rb @@ -34,6 +34,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class AccountGoogleMyBusinessLink + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AccountIdentifier class Representation < Google::Apis::Core::JsonRepresentation; end @@ -976,6 +982,8 @@ module Google property :adult_content, as: 'adultContent' collection :adwords_links, as: 'adwordsLinks', class: Google::Apis::ContentV2::AccountAdwordsLink, decorator: Google::Apis::ContentV2::AccountAdwordsLink::Representation + property :google_my_business_link, as: 'googleMyBusinessLink', class: Google::Apis::ContentV2::AccountGoogleMyBusinessLink, decorator: Google::Apis::ContentV2::AccountGoogleMyBusinessLink::Representation + property :id, :numeric_string => true, as: 'id' property :kind, as: 'kind' property :name, as: 'name' @@ -997,6 +1005,14 @@ module Google end end + class AccountGoogleMyBusinessLink + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :gmb_email, as: 'gmbEmail' + property :status, as: 'status' + end + end + class AccountIdentifier # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1722,7 +1738,6 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :cancellations, as: 'cancellations', class: Google::Apis::ContentV2::OrderCancellation, decorator: Google::Apis::ContentV2::OrderCancellation::Representation - property :channel_type, as: 'channelType' property :id, as: 'id' property :price, as: 'price', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation @@ -1886,6 +1901,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :line_item_id, as: 'lineItemId' + property :product_id, as: 'productId' property :quantity, as: 'quantity' end end @@ -1917,8 +1933,13 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :amount, as: 'amount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + + property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + property :line_item_id, as: 'lineItemId' property :operation_id, as: 'operationId' + property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' @@ -2012,7 +2033,12 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :amount, as: 'amount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + + property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + property :line_item_id, as: 'lineItemId' + property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' @@ -2024,6 +2050,10 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :amount, as: 'amount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + + property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + property :reason, as: 'reason' property :reason_text, as: 'reasonText' end @@ -2033,6 +2063,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :line_item_id, as: 'lineItemId' + property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' @@ -2126,6 +2157,10 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :amount, as: 'amount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + + property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + property :operation_id, as: 'operationId' property :reason, as: 'reason' property :reason_text, as: 'reasonText' @@ -2145,6 +2180,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :line_item_id, as: 'lineItemId' property :operation_id, as: 'operationId' + property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' @@ -2707,6 +2743,7 @@ module Google property :kind, as: 'kind' collection :line_items, as: 'lineItems', class: Google::Apis::ContentV2::TestOrderLineItem, decorator: Google::Apis::ContentV2::TestOrderLineItem::Representation + property :notification_mode, as: 'notificationMode' property :payment_method, as: 'paymentMethod', class: Google::Apis::ContentV2::TestOrderPaymentMethod, decorator: Google::Apis::ContentV2::TestOrderPaymentMethod::Representation property :predefined_delivery_address, as: 'predefinedDeliveryAddress' diff --git a/generated/google/apis/content_v2/service.rb b/generated/google/apis/content_v2/service.rb index e2ee896f1..c9623f13f 100644 --- a/generated/google/apis/content_v2/service.rb +++ b/generated/google/apis/content_v2/service.rb @@ -86,12 +86,11 @@ module Google execute_or_queue_command(command, &block) end - # Claims the website of a Merchant Center sub-account. This method can only be - # called for accounts to which the managing account has access: either the - # managing account itself for any Merchant Center account, or any sub-account - # when the managing account is a multi-client account. + # Claims the website of a Merchant Center sub-account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. If this parameter is not the same as accountId, + # then this account must be a multi-client account and accountId must be the ID + # of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account whose website is claimed. # @param [Boolean] overwrite @@ -171,10 +170,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a Merchant Center sub-account. This method can only be called for - # multi-client accounts. + # Deletes a Merchant Center sub-account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. This must be a multi-client account, and + # accountId must be the ID of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account. # @param [Boolean] dry_run @@ -214,12 +213,11 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a Merchant Center account. This method can only be called for - # accounts to which the managing account has access: either the managing account - # itself for any Merchant Center account, or any sub-account when the managing - # account is a multi-client account. + # Retrieves a Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. If this parameter is not the same as accountId, + # then this account must be a multi-client account and accountId must be the ID + # of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account. # @param [String] fields @@ -255,10 +253,9 @@ module Google execute_or_queue_command(command, &block) end - # Creates a Merchant Center sub-account. This method can only be called for - # multi-client accounts. + # Creates a Merchant Center sub-account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. This must be a multi-client account. # @param [Google::Apis::ContentV2::Account] account_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. @@ -297,10 +294,9 @@ module Google execute_or_queue_command(command, &block) end - # Lists the sub-accounts in your Merchant Center account. This method can only - # be called for multi-client accounts. + # Lists the sub-accounts in your Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. This must be a multi-client account. # @param [Fixnum] max_results # The maximum number of accounts to return in the response, used for paging. # @param [String] page_token @@ -339,12 +335,11 @@ module Google execute_or_queue_command(command, &block) end - # Updates a Merchant Center account. This method can only be called for accounts - # to which the managing account has access: either the managing account itself - # for any Merchant Center account, or any sub-account when the managing account - # is a multi-client account. This method supports patch semantics. + # Updates a Merchant Center account. This method supports patch semantics. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. If this parameter is not the same as accountId, + # then this account must be a multi-client account and accountId must be the ID + # of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account. # @param [Google::Apis::ContentV2::Account] account_object @@ -386,12 +381,11 @@ module Google execute_or_queue_command(command, &block) end - # Updates a Merchant Center account. This method can only be called for accounts - # to which the managing account has access: either the managing account itself - # for any Merchant Center account, or any sub-account when the managing account - # is a multi-client account. + # Updates a Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. If this parameter is not the same as accountId, + # then this account must be a multi-client account and accountId must be the ID + # of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account. # @param [Google::Apis::ContentV2::Account] account_object @@ -468,12 +462,11 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the status of a Merchant Center account. This method can only be - # called for accounts to which the managing account has access: either the - # managing account itself for any Merchant Center account, or any sub-account - # when the managing account is a multi-client account. + # Retrieves the status of a Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. If this parameter is not the same as accountId, + # then this account must be a multi-client account and accountId must be the ID + # of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account. # @param [String] fields @@ -509,10 +502,9 @@ module Google execute_or_queue_command(command, &block) end - # Lists the statuses of the sub-accounts in your Merchant Center account. This - # method can only be called for multi-client accounts. + # Lists the statuses of the sub-accounts in your Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. This must be a multi-client account. # @param [Fixnum] max_results # The maximum number of account statuses to return in the response, used for # paging. @@ -590,12 +582,11 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the tax settings of the account. This method can only be called for - # accounts to which the managing account has access: either the managing account - # itself for any Merchant Center account, or any sub-account when the managing - # account is a multi-client account. + # Retrieves the tax settings of the account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. If this parameter is not the same as accountId, + # then this account must be a multi-client account and accountId must be the ID + # of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get/update account tax settings. # @param [String] fields @@ -632,9 +623,8 @@ module Google end # Lists the tax settings of the sub-accounts in your Merchant Center account. - # This method can only be called for multi-client accounts. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. This must be a multi-client account. # @param [Fixnum] max_results # The maximum number of tax settings to return in the response, used for paging. # @param [String] page_token @@ -673,12 +663,11 @@ module Google execute_or_queue_command(command, &block) end - # Updates the tax settings of the account. This method can only be called for - # accounts to which the managing account has access: either the managing account - # itself for any Merchant Center account, or any sub-account when the managing - # account is a multi-client account. This method supports patch semantics. + # Updates the tax settings of the account. This method supports patch semantics. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. If this parameter is not the same as accountId, + # then this account must be a multi-client account and accountId must be the ID + # of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get/update account tax settings. # @param [Google::Apis::ContentV2::AccountTax] account_tax_object @@ -720,12 +709,11 @@ module Google execute_or_queue_command(command, &block) end - # Updates the tax settings of the account. This method can only be called for - # accounts to which the managing account has access: either the managing account - # itself for any Merchant Center account, or any sub-account when the managing - # account is a multi-client account. + # Updates the tax settings of the account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. If this parameter is not the same as accountId, + # then this account must be a multi-client account and accountId must be the ID + # of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get/update account tax settings. # @param [Google::Apis::ContentV2::AccountTax] account_tax_object @@ -805,10 +793,12 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a datafeed configuration from your Merchant Center account. This - # method can only be called for non-multi-client accounts. + # Deletes a datafeed configuration from your Merchant Center account. # @param [Fixnum] merchant_id + # The ID of the account that manages the datafeed. This account cannot be a + # multi-client account. # @param [Fixnum] datafeed_id + # The ID of the datafeed. # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @param [String] fields @@ -843,10 +833,12 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a datafeed configuration from your Merchant Center account. This - # method can only be called for non-multi-client accounts. + # Retrieves a datafeed configuration from your Merchant Center account. # @param [Fixnum] merchant_id + # The ID of the account that manages the datafeed. This account cannot be a + # multi-client account. # @param [Fixnum] datafeed_id + # The ID of the datafeed. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -880,9 +872,10 @@ module Google execute_or_queue_command(command, &block) end - # Registers a datafeed configuration with your Merchant Center account. This - # method can only be called for non-multi-client accounts. + # Registers a datafeed configuration with your Merchant Center account. # @param [Fixnum] merchant_id + # The ID of the account that manages the datafeed. This account cannot be a + # multi-client account. # @param [Google::Apis::ContentV2::Datafeed] datafeed_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. @@ -921,10 +914,10 @@ module Google execute_or_queue_command(command, &block) end - # Lists the datafeeds in your Merchant Center account. This method can only be - # called for non-multi-client accounts. + # Lists the datafeeds in your Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the datafeeds. This account cannot be a + # multi-client account. # @param [Fixnum] max_results # The maximum number of products to return in the response, used for paging. # @param [String] page_token @@ -964,10 +957,12 @@ module Google end # Updates a datafeed configuration of your Merchant Center account. This method - # can only be called for non-multi-client accounts. This method supports patch - # semantics. + # supports patch semantics. # @param [Fixnum] merchant_id + # The ID of the account that manages the datafeed. This account cannot be a + # multi-client account. # @param [Fixnum] datafeed_id + # The ID of the datafeed. # @param [Google::Apis::ContentV2::Datafeed] datafeed_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. @@ -1007,10 +1002,12 @@ module Google execute_or_queue_command(command, &block) end - # Updates a datafeed configuration of your Merchant Center account. This method - # can only be called for non-multi-client accounts. + # Updates a datafeed configuration of your Merchant Center account. # @param [Fixnum] merchant_id + # The ID of the account that manages the datafeed. This account cannot be a + # multi-client account. # @param [Fixnum] datafeed_id + # The ID of the datafeed. # @param [Google::Apis::ContentV2::Datafeed] datafeed_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. @@ -1085,10 +1082,12 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the status of a datafeed from your Merchant Center account. This - # method can only be called for non-multi-client accounts. + # Retrieves the status of a datafeed from your Merchant Center account. # @param [Fixnum] merchant_id + # The ID of the account that manages the datafeed. This account cannot be a + # multi-client account. # @param [Fixnum] datafeed_id + # The ID of the datafeed. # @param [String] country # The country for which to get the datafeed status. If this parameter is # provided then language must also be provided. Note that this parameter is @@ -1134,10 +1133,10 @@ module Google execute_or_queue_command(command, &block) end - # Lists the statuses of the datafeeds in your Merchant Center account. This - # method can only be called for non-multi-client accounts. + # Lists the statuses of the datafeeds in your Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the datafeeds. This account cannot be a + # multi-client account. # @param [Fixnum] max_results # The maximum number of products to return in the response, used for paging. # @param [String] page_token @@ -1178,7 +1177,6 @@ module Google # Updates price and availability for multiple products or stores in a single # request. This operation does not update the expiration date of the products. - # This method can only be called for non-multi-client accounts. # @param [Google::Apis::ContentV2::BatchInventoryRequest] batch_inventory_request_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. @@ -1217,15 +1215,14 @@ module Google end # Updates price and availability of a product in your Merchant Center account. - # This operation does not update the expiration date of the product. This method - # can only be called for non-multi-client accounts. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that contains the product. This account cannot be a + # multi-client account. # @param [String] store_code # The code of the store for which to update price and availability. Use online # to update price and availability of an online product. # @param [String] product_id - # The ID of the product for which to update price and availability. + # The REST id of the product for which to update price and availability. # @param [Google::Apis::ContentV2::SetInventoryRequest] set_inventory_request_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. @@ -1266,10 +1263,10 @@ module Google execute_or_queue_command(command, &block) end - # Marks an order as acknowledged. This method can only be called for non-multi- - # client accounts. + # Marks an order as acknowledged. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersAcknowledgeRequest] orders_acknowledge_request_object @@ -1309,9 +1306,10 @@ module Google end # Sandbox only. Moves a test order from state "inProgress" to state " - # pendingShipment". This method can only be called for non-multi-client accounts. + # pendingShipment". # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the test order to modify. # @param [String] fields @@ -1347,10 +1345,10 @@ module Google execute_or_queue_command(command, &block) end - # Cancels all line items in an order, making a full refund. This method can only - # be called for non-multi-client accounts. + # Cancels all line items in an order, making a full refund. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order to cancel. # @param [Google::Apis::ContentV2::OrdersCancelRequest] orders_cancel_request_object @@ -1389,10 +1387,10 @@ module Google execute_or_queue_command(command, &block) end - # Cancels a line item, making a full refund. This method can only be called for - # non-multi-client accounts. + # Cancels a line item, making a full refund. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersCancelLineItemRequest] orders_cancel_line_item_request_object @@ -1431,10 +1429,10 @@ module Google execute_or_queue_command(command, &block) end - # Sandbox only. Creates a test order. This method can only be called for non- - # multi-client accounts. + # Sandbox only. Creates a test order. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that should manage the order. This cannot be a multi- + # client account. # @param [Google::Apis::ContentV2::OrdersCreateTestOrderRequest] orders_create_test_order_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1470,8 +1468,7 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves or modifies multiple orders in a single request. This method can - # only be called for non-multi-client accounts. + # Retrieves or modifies multiple orders in a single request. # @param [Google::Apis::ContentV2::OrdersCustomBatchRequest] orders_custom_batch_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1506,10 +1503,10 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves an order from your Merchant Center account. This method can only be - # called for non-multi-client accounts. + # Retrieves an order from your Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order. # @param [String] fields @@ -1545,10 +1542,10 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves an order using merchant order id. This method can only be called for - # non-multi-client accounts. + # Retrieves an order using merchant order id. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] merchant_order_id # The merchant order id to be looked for. # @param [String] fields @@ -1585,10 +1582,10 @@ module Google end # Sandbox only. Retrieves an order template that can be used to quickly create a - # new order in sandbox. This method can only be called for non-multi-client - # accounts. + # new order in sandbox. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that should manage the order. This cannot be a multi- + # client account. # @param [String] template_name # The name of the template to retrieve. # @param [String] fields @@ -1624,10 +1621,10 @@ module Google execute_or_queue_command(command, &block) end - # Lists the orders in your Merchant Center account. This method can only be - # called for non-multi-client accounts. + # Lists the orders in your Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [Boolean] acknowledged # Obtains orders that match the acknowledgement status. When set to true, # obtains orders that have been acknowledged. When false, obtains orders that @@ -1698,10 +1695,10 @@ module Google execute_or_queue_command(command, &block) end - # Refund a portion of the order, up to the full amount paid. This method can - # only be called for non-multi-client accounts. + # Refund a portion of the order, up to the full amount paid. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order to refund. # @param [Google::Apis::ContentV2::OrdersRefundRequest] orders_refund_request_object @@ -1740,10 +1737,10 @@ module Google execute_or_queue_command(command, &block) end - # Returns a line item. This method can only be called for non-multi-client - # accounts. + # Returns a line item. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersReturnLineItemRequest] orders_return_line_item_request_object @@ -1782,10 +1779,10 @@ module Google execute_or_queue_command(command, &block) end - # Marks line item(s) as shipped. This method can only be called for non-multi- - # client accounts. + # Marks line item(s) as shipped. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersShipLineItemsRequest] orders_ship_line_items_request_object @@ -1824,10 +1821,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates the merchant order ID for a given order. This method can only be - # called for non-multi-client accounts. + # Updates the merchant order ID for a given order. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersUpdateMerchantOrderIdRequest] orders_update_merchant_order_id_request_object @@ -1866,10 +1863,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates a shipment's status, carrier, and/or tracking ID. This method can only - # be called for non-multi-client accounts. + # Updates a shipment's status, carrier, and/or tracking ID. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2::OrdersUpdateShipmentRequest] orders_update_shipment_request_object @@ -1908,8 +1905,7 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves, inserts, and deletes multiple products in a single request. This - # method can only be called for non-multi-client accounts. + # Retrieves, inserts, and deletes multiple products in a single request. # @param [Google::Apis::ContentV2::BatchProductsRequest] batch_products_request_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. @@ -1947,12 +1943,12 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a product from your Merchant Center account. This method can only be - # called for non-multi-client accounts. + # Deletes a product from your Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that contains the product. This account cannot be a + # multi-client account. # @param [String] product_id - # The ID of the product. + # The REST id of the product. # @param [Boolean] dry_run # Flag to run the request in dry-run mode. # @param [String] fields @@ -1987,12 +1983,12 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a product from your Merchant Center account. This method can only be - # called for non-multi-client accounts. + # Retrieves a product from your Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that contains the product. This account cannot be a + # multi-client account. # @param [String] product_id - # The ID of the product. + # The REST id of the product. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2028,10 +2024,10 @@ module Google # Uploads a product to your Merchant Center account. If an item with the same # channel, contentLanguage, offerId, and targetCountry already exists, this - # method updates that entry. This method can only be called for non-multi-client - # accounts. + # method updates that entry. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that contains the product. This account cannot be a + # multi-client account. # @param [Google::Apis::ContentV2::Product] product_object # @param [Boolean] dry_run # Flag to run the request in dry-run mode. @@ -2070,10 +2066,10 @@ module Google execute_or_queue_command(command, &block) end - # Lists the products in your Merchant Center account. This method can only be - # called for non-multi-client accounts. + # Lists the products in your Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that contains the products. This account cannot be a + # multi-client account. # @param [Boolean] include_invalid_inserted_items # Flag to include the invalid inserted items in the result of the list request. # By default the invalid items are not shown (the default value is false). @@ -2116,8 +2112,7 @@ module Google execute_or_queue_command(command, &block) end - # Gets the statuses of multiple products in a single request. This method can - # only be called for non-multi-client accounts. + # Gets the statuses of multiple products in a single request. # @param [Google::Apis::ContentV2::BatchProductStatusesRequest] batch_product_statuses_request_object # @param [Boolean] include_attributes # Flag to include full product data in the results of this request. The default @@ -2156,12 +2151,12 @@ module Google execute_or_queue_command(command, &block) end - # Gets the status of a product from your Merchant Center account. This method - # can only be called for non-multi-client accounts. + # Gets the status of a product from your Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that contains the product. This account cannot be a + # multi-client account. # @param [String] product_id - # The ID of the product. + # The REST id of the product. # @param [Boolean] include_attributes # Flag to include full product data in the result of this get request. The # default value is false. @@ -2199,10 +2194,10 @@ module Google execute_or_queue_command(command, &block) end - # Lists the statuses of the products in your Merchant Center account. This - # method can only be called for non-multi-client accounts. + # Lists the statuses of the products in your Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that contains the products. This account cannot be a + # multi-client account. # @param [Boolean] include_attributes # Flag to include full product data in the results of the list request. The # default value is false. @@ -2289,12 +2284,11 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the shipping settings of the account. This method can only be called - # for accounts to which the managing account has access: either the managing - # account itself for any Merchant Center account, or any sub-account when the - # managing account is a multi-client account. + # Retrieves the shipping settings of the account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. If this parameter is not the same as accountId, + # then this account must be a multi-client account and accountId must be the ID + # of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get/update shipping settings. # @param [String] fields @@ -2366,9 +2360,9 @@ module Google end # Lists the shipping settings of the sub-accounts in your Merchant Center - # account. This method can only be called for multi-client accounts. + # account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. This must be a multi-client account. # @param [Fixnum] max_results # The maximum number of shipping settings to return in the response, used for # paging. @@ -2408,13 +2402,12 @@ module Google execute_or_queue_command(command, &block) end - # Updates the shipping settings of the account. This method can only be called - # for accounts to which the managing account has access: either the managing - # account itself for any Merchant Center account, or any sub-account when the - # managing account is a multi-client account. This method supports patch + # Updates the shipping settings of the account. This method supports patch # semantics. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. If this parameter is not the same as accountId, + # then this account must be a multi-client account and accountId must be the ID + # of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get/update shipping settings. # @param [Google::Apis::ContentV2::ShippingSettings] shipping_settings_object @@ -2456,12 +2449,11 @@ module Google execute_or_queue_command(command, &block) end - # Updates the shipping settings of the account. This method can only be called - # for accounts to which the managing account has access: either the managing - # account itself for any Merchant Center account, or any sub-account when the - # managing account is a multi-client account. + # Updates the shipping settings of the account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the managing account. If this parameter is not the same as accountId, + # then this account must be a multi-client account and accountId must be the ID + # of a sub-account of this account. # @param [Fixnum] account_id # The ID of the account for which to get/update shipping settings. # @param [Google::Apis::ContentV2::ShippingSettings] shipping_settings_object diff --git a/generated/google/apis/content_v2sandbox.rb b/generated/google/apis/content_v2sandbox.rb index b521a9aab..6f07942f9 100644 --- a/generated/google/apis/content_v2sandbox.rb +++ b/generated/google/apis/content_v2sandbox.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/shopping-content module ContentV2sandbox VERSION = 'V2sandbox' - REVISION = '20170928' + REVISION = '20171124' # Manage your product listings and accounts for Google Shopping AUTH_CONTENT = 'https://www.googleapis.com/auth/content' diff --git a/generated/google/apis/content_v2sandbox/classes.rb b/generated/google/apis/content_v2sandbox/classes.rb index 3aa87b42c..724e2d3d6 100644 --- a/generated/google/apis/content_v2sandbox/classes.rb +++ b/generated/google/apis/content_v2sandbox/classes.rb @@ -404,11 +404,6 @@ module Google # @return [Array] attr_accessor :cancellations - # The channel type of the order: "purchaseOnGoogle" or "googleExpress". - # Corresponds to the JSON property `channelType` - # @return [String] - attr_accessor :channel_type - # The id of the line item. # Corresponds to the JSON property `id` # @return [String] @@ -483,7 +478,6 @@ module Google # Update properties of this object def update!(**args) @cancellations = args[:cancellations] if args.key?(:cancellations) - @channel_type = args[:channel_type] if args.key?(:channel_type) @id = args[:id] if args.key?(:id) @price = args[:price] if args.key?(:price) @product = args[:product] if args.key?(:product) @@ -990,26 +984,20 @@ module Google # Acceptable values are: # - "gsx" # - "ups" - # - "united parcel service" # - "usps" - # - "united states postal service" # - "fedex" # - "dhl" # - "ecourier" # - "cxt" # - "google" - # - "on trac" # - "ontrac" - # - "on-trac" - # - "on_trac" - # - "delvic" + # - "emsy" + # - "ont" + # - "deliv" # - "dynamex" # - "lasership" - # - "smartpost" - # - "fedex smartpost" # - "mpx" # - "uds" - # - "united delivery service" # Corresponds to the JSON property `carrier` # @return [String] attr_accessor :carrier @@ -1065,11 +1053,18 @@ module Google class OrderShipmentLineItemShipment include Google::Apis::Core::Hashable - # The id of the line item that is shipped. + # The id of the line item that is shipped. Either lineItemId or productId is + # required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id + # The ID of the product to ship. This is the REST ID used in the products + # service. Either lineItemId or productId is required. + # Corresponds to the JSON property `productId` + # @return [String] + attr_accessor :product_id + # The quantity that is shipped. # Corresponds to the JSON property `quantity` # @return [Fixnum] @@ -1082,6 +1077,7 @@ module Google # Update properties of this object def update!(**args) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) + @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) end end @@ -1162,7 +1158,19 @@ module Google # @return [Google::Apis::ContentV2sandbox::Price] attr_accessor :amount - # The ID of the line item to cancel. + # Amount to refund for the cancelation. Optional. If not set, Google will + # calculate the default based on the price and tax of the items involved. The + # amount must not be larger than the net amount left on the order. + # Corresponds to the JSON property `amountPretax` + # @return [Google::Apis::ContentV2sandbox::Price] + attr_accessor :amount_pretax + + # Tax amount that correspond to cancellation amount in amountPretax. + # Corresponds to the JSON property `amountTax` + # @return [Google::Apis::ContentV2sandbox::Price] + attr_accessor :amount_tax + + # The ID of the line item to cancel. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id @@ -1172,6 +1180,12 @@ module Google # @return [String] attr_accessor :operation_id + # The ID of the product to cancel. This is the REST ID used in the products + # service. Either lineItemId or productId is required. + # Corresponds to the JSON property `productId` + # @return [String] + attr_accessor :product_id + # The quantity to cancel. # Corresponds to the JSON property `quantity` # @return [Fixnum] @@ -1194,8 +1208,11 @@ module Google # Update properties of this object def update!(**args) @amount = args[:amount] if args.key?(:amount) + @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) + @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @operation_id = args[:operation_id] if args.key?(:operation_id) + @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) @@ -1480,11 +1497,29 @@ module Google # @return [Google::Apis::ContentV2sandbox::Price] attr_accessor :amount - # The ID of the line item to cancel. + # Amount to refund for the cancelation. Optional. If not set, Google will + # calculate the default based on the price and tax of the items involved. The + # amount must not be larger than the net amount left on the order. + # Corresponds to the JSON property `amountPretax` + # @return [Google::Apis::ContentV2sandbox::Price] + attr_accessor :amount_pretax + + # Tax amount that correspond to cancellation amount in amountPretax. + # Corresponds to the JSON property `amountTax` + # @return [Google::Apis::ContentV2sandbox::Price] + attr_accessor :amount_tax + + # The ID of the line item to cancel. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id + # The ID of the product to cancel. This is the REST ID used in the products + # service. Either lineItemId or productId is required. + # Corresponds to the JSON property `productId` + # @return [String] + attr_accessor :product_id + # The quantity to cancel. # Corresponds to the JSON property `quantity` # @return [Fixnum] @@ -1507,7 +1542,10 @@ module Google # Update properties of this object def update!(**args) @amount = args[:amount] if args.key?(:amount) + @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) + @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) + @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) @@ -1523,6 +1561,17 @@ module Google # @return [Google::Apis::ContentV2sandbox::Price] attr_accessor :amount + # The amount that is refunded. Either amount or amountPretax and amountTax + # should be filled. + # Corresponds to the JSON property `amountPretax` + # @return [Google::Apis::ContentV2sandbox::Price] + attr_accessor :amount_pretax + + # Tax amount that correspond to refund amount in amountPretax. + # Corresponds to the JSON property `amountTax` + # @return [Google::Apis::ContentV2sandbox::Price] + attr_accessor :amount_tax + # The reason for the refund. # Corresponds to the JSON property `reason` # @return [String] @@ -1540,6 +1589,8 @@ module Google # Update properties of this object def update!(**args) @amount = args[:amount] if args.key?(:amount) + @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) + @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) end @@ -1549,11 +1600,17 @@ module Google class OrdersCustomBatchRequestEntryReturnLineItem include Google::Apis::Core::Hashable - # The ID of the line item to return. + # The ID of the line item to return. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id + # The ID of the product to return. This is the REST ID used in the products + # service. Either lineItemId or productId is required. + # Corresponds to the JSON property `productId` + # @return [String] + attr_accessor :product_id + # The quantity to return. # Corresponds to the JSON property `quantity` # @return [Fixnum] @@ -1576,6 +1633,7 @@ module Google # Update properties of this object def update!(**args) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) + @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) @@ -1863,6 +1921,17 @@ module Google # @return [Google::Apis::ContentV2sandbox::Price] attr_accessor :amount + # The amount that is refunded. Either amount or amountPretax and amountTax + # should be filled. + # Corresponds to the JSON property `amountPretax` + # @return [Google::Apis::ContentV2sandbox::Price] + attr_accessor :amount_pretax + + # Tax amount that correspond to refund amount in amountPretax. + # Corresponds to the JSON property `amountTax` + # @return [Google::Apis::ContentV2sandbox::Price] + attr_accessor :amount_tax + # The ID of the operation. Unique across all operations for a given order. # Corresponds to the JSON property `operationId` # @return [String] @@ -1885,6 +1954,8 @@ module Google # Update properties of this object def update!(**args) @amount = args[:amount] if args.key?(:amount) + @amount_pretax = args[:amount_pretax] if args.key?(:amount_pretax) + @amount_tax = args[:amount_tax] if args.key?(:amount_tax) @operation_id = args[:operation_id] if args.key?(:operation_id) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) @@ -1921,7 +1992,7 @@ module Google class OrdersReturnLineItemRequest include Google::Apis::Core::Hashable - # The ID of the line item to return. + # The ID of the line item to return. Either lineItemId or productId is required. # Corresponds to the JSON property `lineItemId` # @return [String] attr_accessor :line_item_id @@ -1931,6 +2002,12 @@ module Google # @return [String] attr_accessor :operation_id + # The ID of the product to return. This is the REST ID used in the products + # service. Either lineItemId or productId is required. + # Corresponds to the JSON property `productId` + # @return [String] + attr_accessor :product_id + # The quantity to return. # Corresponds to the JSON property `quantity` # @return [Fixnum] @@ -1954,6 +2031,7 @@ module Google def update!(**args) @line_item_id = args[:line_item_id] if args.key?(:line_item_id) @operation_id = args[:operation_id] if args.key?(:operation_id) + @product_id = args[:product_id] if args.key?(:product_id) @quantity = args[:quantity] if args.key?(:quantity) @reason = args[:reason] if args.key?(:reason) @reason_text = args[:reason_text] if args.key?(:reason_text) @@ -2230,6 +2308,12 @@ module Google # @return [Array] attr_accessor :line_items + # Determines if test order must be pulled by merchant or pushed to merchant via + # push integration. + # Corresponds to the JSON property `notificationMode` + # @return [String] + attr_accessor :notification_mode + # The details of the payment method. # Corresponds to the JSON property `paymentMethod` # @return [Google::Apis::ContentV2sandbox::TestOrderPaymentMethod] @@ -2270,6 +2354,7 @@ module Google @customer = args[:customer] if args.key?(:customer) @kind = args[:kind] if args.key?(:kind) @line_items = args[:line_items] if args.key?(:line_items) + @notification_mode = args[:notification_mode] if args.key?(:notification_mode) @payment_method = args[:payment_method] if args.key?(:payment_method) @predefined_delivery_address = args[:predefined_delivery_address] if args.key?(:predefined_delivery_address) @promotions = args[:promotions] if args.key?(:promotions) diff --git a/generated/google/apis/content_v2sandbox/representations.rb b/generated/google/apis/content_v2sandbox/representations.rb index c42e00fb1..33a069fb5 100644 --- a/generated/google/apis/content_v2sandbox/representations.rb +++ b/generated/google/apis/content_v2sandbox/representations.rb @@ -479,7 +479,6 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :cancellations, as: 'cancellations', class: Google::Apis::ContentV2sandbox::OrderCancellation, decorator: Google::Apis::ContentV2sandbox::OrderCancellation::Representation - property :channel_type, as: 'channelType' property :id, as: 'id' property :price, as: 'price', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation @@ -643,6 +642,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :line_item_id, as: 'lineItemId' + property :product_id, as: 'productId' property :quantity, as: 'quantity' end end @@ -674,8 +674,13 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :amount, as: 'amount', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation + property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation + + property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation + property :line_item_id, as: 'lineItemId' property :operation_id, as: 'operationId' + property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' @@ -769,7 +774,12 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :amount, as: 'amount', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation + property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation + + property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation + property :line_item_id, as: 'lineItemId' + property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' @@ -781,6 +791,10 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :amount, as: 'amount', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation + property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation + + property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation + property :reason, as: 'reason' property :reason_text, as: 'reasonText' end @@ -790,6 +804,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :line_item_id, as: 'lineItemId' + property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' @@ -883,6 +898,10 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :amount, as: 'amount', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation + property :amount_pretax, as: 'amountPretax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation + + property :amount_tax, as: 'amountTax', class: Google::Apis::ContentV2sandbox::Price, decorator: Google::Apis::ContentV2sandbox::Price::Representation + property :operation_id, as: 'operationId' property :reason, as: 'reason' property :reason_text, as: 'reasonText' @@ -902,6 +921,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :line_item_id, as: 'lineItemId' property :operation_id, as: 'operationId' + property :product_id, as: 'productId' property :quantity, as: 'quantity' property :reason, as: 'reason' property :reason_text, as: 'reasonText' @@ -989,6 +1009,7 @@ module Google property :kind, as: 'kind' collection :line_items, as: 'lineItems', class: Google::Apis::ContentV2sandbox::TestOrderLineItem, decorator: Google::Apis::ContentV2sandbox::TestOrderLineItem::Representation + property :notification_mode, as: 'notificationMode' property :payment_method, as: 'paymentMethod', class: Google::Apis::ContentV2sandbox::TestOrderPaymentMethod, decorator: Google::Apis::ContentV2sandbox::TestOrderPaymentMethod::Representation property :predefined_delivery_address, as: 'predefinedDeliveryAddress' diff --git a/generated/google/apis/content_v2sandbox/service.rb b/generated/google/apis/content_v2sandbox/service.rb index f1f769c82..845dfcc6d 100644 --- a/generated/google/apis/content_v2sandbox/service.rb +++ b/generated/google/apis/content_v2sandbox/service.rb @@ -54,10 +54,10 @@ module Google @batch_path = 'batch/content/v2sandbox' end - # Marks an order as acknowledged. This method can only be called for non-multi- - # client accounts. + # Marks an order as acknowledged. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2sandbox::OrdersAcknowledgeRequest] orders_acknowledge_request_object @@ -97,9 +97,10 @@ module Google end # Sandbox only. Moves a test order from state "inProgress" to state " - # pendingShipment". This method can only be called for non-multi-client accounts. + # pendingShipment". # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the test order to modify. # @param [String] fields @@ -135,10 +136,10 @@ module Google execute_or_queue_command(command, &block) end - # Cancels all line items in an order, making a full refund. This method can only - # be called for non-multi-client accounts. + # Cancels all line items in an order, making a full refund. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order to cancel. # @param [Google::Apis::ContentV2sandbox::OrdersCancelRequest] orders_cancel_request_object @@ -177,10 +178,10 @@ module Google execute_or_queue_command(command, &block) end - # Cancels a line item, making a full refund. This method can only be called for - # non-multi-client accounts. + # Cancels a line item, making a full refund. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2sandbox::OrdersCancelLineItemRequest] orders_cancel_line_item_request_object @@ -219,10 +220,10 @@ module Google execute_or_queue_command(command, &block) end - # Sandbox only. Creates a test order. This method can only be called for non- - # multi-client accounts. + # Sandbox only. Creates a test order. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that should manage the order. This cannot be a multi- + # client account. # @param [Google::Apis::ContentV2sandbox::OrdersCreateTestOrderRequest] orders_create_test_order_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -258,8 +259,7 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves or modifies multiple orders in a single request. This method can - # only be called for non-multi-client accounts. + # Retrieves or modifies multiple orders in a single request. # @param [Google::Apis::ContentV2sandbox::OrdersCustomBatchRequest] orders_custom_batch_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -294,10 +294,10 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves an order from your Merchant Center account. This method can only be - # called for non-multi-client accounts. + # Retrieves an order from your Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order. # @param [String] fields @@ -333,10 +333,10 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves an order using merchant order id. This method can only be called for - # non-multi-client accounts. + # Retrieves an order using merchant order id. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] merchant_order_id # The merchant order id to be looked for. # @param [String] fields @@ -373,10 +373,10 @@ module Google end # Sandbox only. Retrieves an order template that can be used to quickly create a - # new order in sandbox. This method can only be called for non-multi-client - # accounts. + # new order in sandbox. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that should manage the order. This cannot be a multi- + # client account. # @param [String] template_name # The name of the template to retrieve. # @param [String] fields @@ -412,10 +412,10 @@ module Google execute_or_queue_command(command, &block) end - # Lists the orders in your Merchant Center account. This method can only be - # called for non-multi-client accounts. + # Lists the orders in your Merchant Center account. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [Boolean] acknowledged # Obtains orders that match the acknowledgement status. When set to true, # obtains orders that have been acknowledged. When false, obtains orders that @@ -486,10 +486,10 @@ module Google execute_or_queue_command(command, &block) end - # Refund a portion of the order, up to the full amount paid. This method can - # only be called for non-multi-client accounts. + # Refund a portion of the order, up to the full amount paid. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order to refund. # @param [Google::Apis::ContentV2sandbox::OrdersRefundRequest] orders_refund_request_object @@ -528,10 +528,10 @@ module Google execute_or_queue_command(command, &block) end - # Returns a line item. This method can only be called for non-multi-client - # accounts. + # Returns a line item. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2sandbox::OrdersReturnLineItemRequest] orders_return_line_item_request_object @@ -570,10 +570,10 @@ module Google execute_or_queue_command(command, &block) end - # Marks line item(s) as shipped. This method can only be called for non-multi- - # client accounts. + # Marks line item(s) as shipped. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2sandbox::OrdersShipLineItemsRequest] orders_ship_line_items_request_object @@ -612,10 +612,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates the merchant order ID for a given order. This method can only be - # called for non-multi-client accounts. + # Updates the merchant order ID for a given order. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2sandbox::OrdersUpdateMerchantOrderIdRequest] orders_update_merchant_order_id_request_object @@ -654,10 +654,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates a shipment's status, carrier, and/or tracking ID. This method can only - # be called for non-multi-client accounts. + # Updates a shipment's status, carrier, and/or tracking ID. # @param [Fixnum] merchant_id - # The ID of the managing account. + # The ID of the account that manages the order. This cannot be a multi-client + # account. # @param [String] order_id # The ID of the order. # @param [Google::Apis::ContentV2sandbox::OrdersUpdateShipmentRequest] orders_update_shipment_request_object diff --git a/generated/google/apis/customsearch_v1.rb b/generated/google/apis/customsearch_v1.rb index 42ef1a5d6..232fabaf5 100644 --- a/generated/google/apis/customsearch_v1.rb +++ b/generated/google/apis/customsearch_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/custom-search/v1/using_rest module CustomsearchV1 VERSION = 'V1' - REVISION = '20170615' + REVISION = '20171116' end end end diff --git a/generated/google/apis/customsearch_v1/service.rb b/generated/google/apis/customsearch_v1/service.rb index 2cb48d6b4..227a41add 100644 --- a/generated/google/apis/customsearch_v1/service.rb +++ b/generated/google/apis/customsearch_v1/service.rb @@ -191,6 +191,146 @@ module Google command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end + + # (Closed Beta API) Returns metadata about the search performed, metadata about + # the custom search engine used for the search, and the search results only for + # site-restrict cses. + # @param [String] q + # Query + # @param [String] c2coff + # Turns off the translation between zh-CN and zh-TW. + # @param [String] cr + # Country restrict(s). + # @param [String] cx + # The custom search engine ID to scope this search query + # @param [String] date_restrict + # Specifies all search results are from a time period + # @param [String] exact_terms + # Identifies a phrase that all documents in the search results must contain + # @param [String] exclude_terms + # Identifies a word or phrase that should not appear in any documents in the + # search results + # @param [String] file_type + # Returns images of a specified type. Some of the allowed values are: bmp, gif, + # png, jpg, svg, pdf, ... + # @param [String] filter + # Controls turning on or off the duplicate content filter. + # @param [String] gl + # Geolocation of end user. + # @param [String] googlehost + # The local Google domain to use to perform the search. + # @param [String] high_range + # Creates a range in form as_nlo value..as_nhi value and attempts to append it + # to query + # @param [String] hl + # Sets the user interface language. + # @param [String] hq + # Appends the extra query terms to the query. + # @param [String] img_color_type + # Returns black and white, grayscale, or color images: mono, gray, and color. + # @param [String] img_dominant_color + # Returns images of a specific dominant color: yellow, green, teal, blue, purple, + # pink, white, gray, black and brown. + # @param [String] img_size + # Returns images of a specified size, where size can be one of: icon, small, + # medium, large, xlarge, xxlarge, and huge. + # @param [String] img_type + # Returns images of a type, which can be one of: clipart, face, lineart, news, + # and photo. + # @param [String] link_site + # Specifies that all search results should contain a link to a particular URL + # @param [String] low_range + # Creates a range in form as_nlo value..as_nhi value and attempts to append it + # to query + # @param [String] lr + # The language restriction for the search results + # @param [Fixnum] num + # Number of search results to return + # @param [String] or_terms + # Provides additional search terms to check for in a document, where each + # document in the search results must contain at least one of the additional + # search terms + # @param [String] related_site + # Specifies that all search results should be pages that are related to the + # specified URL + # @param [String] rights + # Filters based on licensing. Supported values include: cc_publicdomain, + # cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations + # of these. + # @param [String] safe + # Search safety level + # @param [String] search_type + # Specifies the search type: image. + # @param [String] site_search + # Specifies all search results should be pages from a given site + # @param [String] site_search_filter + # Controls whether to include or exclude results from the site named in the + # as_sitesearch parameter + # @param [String] sort + # The sort expression to apply to the results + # @param [Fixnum] start + # The index of the first result to return + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CustomsearchV1::Search] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CustomsearchV1::Search] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_cse_siterestricts(q, c2coff: nil, cr: nil, cx: nil, date_restrict: nil, exact_terms: nil, exclude_terms: nil, file_type: nil, filter: nil, gl: nil, googlehost: nil, high_range: nil, hl: nil, hq: nil, img_color_type: nil, img_dominant_color: nil, img_size: nil, img_type: nil, link_site: nil, low_range: nil, lr: nil, num: nil, or_terms: nil, related_site: nil, rights: nil, safe: nil, search_type: nil, site_search: nil, site_search_filter: nil, sort: nil, start: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/siterestrict', options) + command.response_representation = Google::Apis::CustomsearchV1::Search::Representation + command.response_class = Google::Apis::CustomsearchV1::Search + command.query['c2coff'] = c2coff unless c2coff.nil? + command.query['cr'] = cr unless cr.nil? + command.query['cx'] = cx unless cx.nil? + command.query['dateRestrict'] = date_restrict unless date_restrict.nil? + command.query['exactTerms'] = exact_terms unless exact_terms.nil? + command.query['excludeTerms'] = exclude_terms unless exclude_terms.nil? + command.query['fileType'] = file_type unless file_type.nil? + command.query['filter'] = filter unless filter.nil? + command.query['gl'] = gl unless gl.nil? + command.query['googlehost'] = googlehost unless googlehost.nil? + command.query['highRange'] = high_range unless high_range.nil? + command.query['hl'] = hl unless hl.nil? + command.query['hq'] = hq unless hq.nil? + command.query['imgColorType'] = img_color_type unless img_color_type.nil? + command.query['imgDominantColor'] = img_dominant_color unless img_dominant_color.nil? + command.query['imgSize'] = img_size unless img_size.nil? + command.query['imgType'] = img_type unless img_type.nil? + command.query['linkSite'] = link_site unless link_site.nil? + command.query['lowRange'] = low_range unless low_range.nil? + command.query['lr'] = lr unless lr.nil? + command.query['num'] = num unless num.nil? + command.query['orTerms'] = or_terms unless or_terms.nil? + command.query['q'] = q unless q.nil? + command.query['relatedSite'] = related_site unless related_site.nil? + command.query['rights'] = rights unless rights.nil? + command.query['safe'] = safe unless safe.nil? + command.query['searchType'] = search_type unless search_type.nil? + command.query['siteSearch'] = site_search unless site_search.nil? + command.query['siteSearchFilter'] = site_search_filter unless site_search_filter.nil? + command.query['sort'] = sort unless sort.nil? + command.query['start'] = start unless start.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end protected diff --git a/generated/google/apis/dataflow_v1b3.rb b/generated/google/apis/dataflow_v1b3.rb index 023f985dd..5c865d67f 100644 --- a/generated/google/apis/dataflow_v1b3.rb +++ b/generated/google/apis/dataflow_v1b3.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/dataflow module DataflowV1b3 VERSION = 'V1b3' - REVISION = '20170930' + REVISION = '20171031' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dataflow_v1b3/classes.rb b/generated/google/apis/dataflow_v1b3/classes.rb index a7a1ff2f8..a69e56c4d 100644 --- a/generated/google/apis/dataflow_v1b3/classes.rb +++ b/generated/google/apis/dataflow_v1b3/classes.rb @@ -425,6 +425,16 @@ module Google # @return [String] attr_accessor :execution_step_name + # Index of an input collection that's being read from/written to as a side + # input. + # The index identifies a step's side inputs starting by 1 (e.g. the first + # side input has input_index 1, the third has input_index 3). + # Side inputs are identified by a pair of (original_step_name, input_index). + # This field helps uniquely identify them. + # Corresponds to the JSON property `inputIndex` + # @return [Fixnum] + attr_accessor :input_index + # Counter name. Not necessarily globally-unique, but unique within the # context of the other fields. # Required. @@ -442,10 +452,12 @@ module Google # @return [String] attr_accessor :origin_namespace - # The GroupByKey step name from the original graph. - # Corresponds to the JSON property `originalShuffleStepName` + # The step name requesting an operation, such as GBK. + # I.e. the ParDo causing a read/write from shuffle to occur, or a + # read from side inputs. + # Corresponds to the JSON property `originalRequestingStepName` # @return [String] - attr_accessor :original_shuffle_step_name + attr_accessor :original_requesting_step_name # System generated name of the original step in the user's graph, before # optimization. @@ -458,11 +470,6 @@ module Google # @return [String] attr_accessor :portion - # Uniquely identifies a side input. - # Corresponds to the JSON property `sideInput` - # @return [Google::Apis::DataflowV1b3::SideInputId] - attr_accessor :side_input - # ID of a particular worker. # Corresponds to the JSON property `workerId` # @return [String] @@ -476,13 +483,13 @@ module Google def update!(**args) @component_step_name = args[:component_step_name] if args.key?(:component_step_name) @execution_step_name = args[:execution_step_name] if args.key?(:execution_step_name) + @input_index = args[:input_index] if args.key?(:input_index) @name = args[:name] if args.key?(:name) @origin = args[:origin] if args.key?(:origin) @origin_namespace = args[:origin_namespace] if args.key?(:origin_namespace) - @original_shuffle_step_name = args[:original_shuffle_step_name] if args.key?(:original_shuffle_step_name) + @original_requesting_step_name = args[:original_requesting_step_name] if args.key?(:original_requesting_step_name) @original_step_name = args[:original_step_name] if args.key?(:original_step_name) @portion = args[:portion] if args.key?(:portion) - @side_input = args[:side_input] if args.key?(:side_input) @worker_id = args[:worker_id] if args.key?(:worker_id) end end @@ -3178,31 +3185,6 @@ module Google end end - # Uniquely identifies a side input. - class SideInputId - include Google::Apis::Core::Hashable - - # The step that receives and usually consumes this side input. - # Corresponds to the JSON property `declaringStepName` - # @return [String] - attr_accessor :declaring_step_name - - # The index of the side input, from the list of non_parallel_inputs. - # Corresponds to the JSON property `inputIndex` - # @return [Fixnum] - attr_accessor :input_index - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @declaring_step_name = args[:declaring_step_name] if args.key?(:declaring_step_name) - @input_index = args[:input_index] if args.key?(:input_index) - end - end - # Information about a side input of a DoFn or an input of a SeqDoFn. class SideInputInfo include Google::Apis::Core::Hashable @@ -3457,6 +3439,17 @@ module Google # @return [Google::Apis::DataflowV1b3::SourceGetMetadataRequest] attr_accessor :get_metadata + # User-provided name of the Read instruction for this source. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # System-defined name for the Read instruction for this source + # in the original workflow graph. + # Corresponds to the JSON property `originalName` + # @return [String] + attr_accessor :original_name + # Represents the operation to split a high-level Source specification # into bundles (parts for parallel processing). # At a high level, splitting of a source into bundles happens as follows: @@ -3473,6 +3466,18 @@ module Google # @return [Google::Apis::DataflowV1b3::SourceSplitRequest] attr_accessor :split + # System-defined name of the stage containing the source operation. + # Unique across the workflow. + # Corresponds to the JSON property `stageName` + # @return [String] + attr_accessor :stage_name + + # System-defined name of the Read instruction for this source. + # Unique across the workflow. + # Corresponds to the JSON property `systemName` + # @return [String] + attr_accessor :system_name + def initialize(**args) update!(**args) end @@ -3480,7 +3485,11 @@ module Google # Update properties of this object def update!(**args) @get_metadata = args[:get_metadata] if args.key?(:get_metadata) + @name = args[:name] if args.key?(:name) + @original_name = args[:original_name] if args.key?(:original_name) @split = args[:split] if args.key?(:split) + @stage_name = args[:stage_name] if args.key?(:stage_name) + @system_name = args[:system_name] if args.key?(:system_name) end end diff --git a/generated/google/apis/dataflow_v1b3/representations.rb b/generated/google/apis/dataflow_v1b3/representations.rb index 31ed69b9a..03c5c5a50 100644 --- a/generated/google/apis/dataflow_v1b3/representations.rb +++ b/generated/google/apis/dataflow_v1b3/representations.rb @@ -502,12 +502,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class SideInputId - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class SideInputInfo class Representation < Google::Apis::Core::JsonRepresentation; end @@ -897,14 +891,13 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :component_step_name, as: 'componentStepName' property :execution_step_name, as: 'executionStepName' + property :input_index, as: 'inputIndex' property :name, as: 'name' property :origin, as: 'origin' property :origin_namespace, as: 'originNamespace' - property :original_shuffle_step_name, as: 'originalShuffleStepName' + property :original_requesting_step_name, as: 'originalRequestingStepName' property :original_step_name, as: 'originalStepName' property :portion, as: 'portion' - property :side_input, as: 'sideInput', class: Google::Apis::DataflowV1b3::SideInputId, decorator: Google::Apis::DataflowV1b3::SideInputId::Representation - property :worker_id, as: 'workerId' end end @@ -1634,14 +1627,6 @@ module Google end end - class SideInputId - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :declaring_step_name, as: 'declaringStepName' - property :input_index, as: 'inputIndex' - end - end - class SideInputInfo # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1716,8 +1701,12 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :get_metadata, as: 'getMetadata', class: Google::Apis::DataflowV1b3::SourceGetMetadataRequest, decorator: Google::Apis::DataflowV1b3::SourceGetMetadataRequest::Representation + property :name, as: 'name' + property :original_name, as: 'originalName' property :split, as: 'split', class: Google::Apis::DataflowV1b3::SourceSplitRequest, decorator: Google::Apis::DataflowV1b3::SourceSplitRequest::Representation + property :stage_name, as: 'stageName' + property :system_name, as: 'systemName' end end diff --git a/generated/google/apis/dataproc_v1.rb b/generated/google/apis/dataproc_v1.rb index b50ca3ddd..4385a9e86 100644 --- a/generated/google/apis/dataproc_v1.rb +++ b/generated/google/apis/dataproc_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/dataproc/ module DataprocV1 VERSION = 'V1' - REVISION = '20170822' + REVISION = '20171031' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dataproc_v1/service.rb b/generated/google/apis/dataproc_v1/service.rb index 92d94c464..18135f33c 100644 --- a/generated/google/apis/dataproc_v1/service.rb +++ b/generated/google/apis/dataproc_v1/service.rb @@ -446,13 +446,13 @@ module Google # Optional. A filter constraining the jobs to list. Filters are case-sensitive # and have the following syntax:field = value AND field = value ...where field # is status.state or labels.[KEY], and [KEY] is a label key. value can be * to - # match all values. status.state can be either ACTIVE or INACTIVE. Only the + # match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the # logical AND operator is supported; space-separated items are treated as having # an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = # staging AND labels.starred = * # @param [String] job_state_matcher - # Optional. Specifies enumerated categories of jobs to list (default = match ALL - # jobs). + # Optional. Specifies enumerated categories of jobs to list. (default = match + # ALL jobs).If filter is provided, jobStateMatcher will be ignored. # @param [Fixnum] page_size # Optional. The number of results to return in each response. # @param [String] page_token diff --git a/generated/google/apis/dataproc_v1beta2.rb b/generated/google/apis/dataproc_v1beta2.rb index dac772193..5ac246929 100644 --- a/generated/google/apis/dataproc_v1beta2.rb +++ b/generated/google/apis/dataproc_v1beta2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/dataproc/ module DataprocV1beta2 VERSION = 'V1beta2' - REVISION = '20171003' + REVISION = '20171031' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dataproc_v1beta2/classes.rb b/generated/google/apis/dataproc_v1beta2/classes.rb index 96b6e2d1a..d3ea5f320 100644 --- a/generated/google/apis/dataproc_v1beta2/classes.rb +++ b/generated/google/apis/dataproc_v1beta2/classes.rb @@ -286,18 +286,18 @@ module Google class ClusterOperation include Google::Apis::Core::Hashable - # Output-only Indicates the operation is done. + # Output only. Indicates the operation is done. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done - # Output-only Error, if operation failed. + # Output only. Error, if operation failed. # Corresponds to the JSON property `error` # @return [String] attr_accessor :error - # Output-only The id of the cluster operation. + # Output only. The id of the cluster operation. # Corresponds to the JSON property `operationId` # @return [String] attr_accessor :operation_id @@ -416,12 +416,14 @@ module Google class ClusterSelector include Google::Apis::Core::Hashable - # Required The cluster labels. Cluster must have all labels to match. + # Required. The cluster labels. Cluster must have all labels to match. # Corresponds to the JSON property `clusterLabels` # @return [Hash] attr_accessor :cluster_labels - # Required The cluster target zone. + # Optional. The zone where workflow process executes. This parameter does not + # affect the selection of the cluster.If unspecified, the zone of the first + # cluster matching the selector is used. # Corresponds to the JSON property `zone` # @return [String] attr_accessor :zone @@ -877,7 +879,7 @@ module Google class InstantiateWorkflowTemplateRequest include Google::Apis::Core::Hashable - # Optional A tag that prevents multiple concurrent workflow instances with the + # Optional. A tag that prevents multiple concurrent workflow instances with the # same tag from running. This mitigates risk of concurrent instances started due # to retries.It is recommended to always set this value to a UUID (https://en. # wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only @@ -887,7 +889,7 @@ module Google # @return [String] attr_accessor :instance_id - # Optional The version of workflow template to instantiate. If specified, the + # Optional. The version of workflow template to instantiate. If specified, the # workflow will be instantiated only if the current version of the workflow # template has the supplied version.This option cannot be used to instantiate a # previous version of workflow template. @@ -1260,14 +1262,14 @@ module Google class ListWorkflowTemplatesResponse include Google::Apis::Core::Hashable - # Output-only This token is included in the response if there are more results + # Output only. This token is included in the response if there are more results # to fetch. To fetch additional results, provide this value as the page_token in # a subsequent ListWorkflowTemplatesRequest. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # Output-only WorkflowTemplates list. + # Output only. WorkflowTemplates list. # Corresponds to the JSON property `templates` # @return [Array] attr_accessor :templates @@ -1308,7 +1310,7 @@ module Google class ManagedCluster include Google::Apis::Core::Hashable - # Required The cluster name. Cluster names within a project must be unique. + # Required. The cluster name. Cluster names within a project must be unique. # Names from deleted clusters can be reused. # Corresponds to the JSON property `clusterName` # @return [String] @@ -1319,7 +1321,7 @@ module Google # @return [Google::Apis::DataprocV1beta2::ClusterConfig] attr_accessor :config - # Optional The labels to associate with this cluster.Label keys must be between + # Optional. The labels to associate with this cluster.Label keys must be between # 1 and 63 characters long, and must conform to the following PCRE regular # expression: \p`Ll`\p`Lo``0,62`Label values must be between 1 and 63 characters # long, and must conform to the following PCRE regular expression: \p`Ll`\p`Lo`\ @@ -1503,7 +1505,7 @@ module Google # @return [Google::Apis::DataprocV1beta2::HiveJob] attr_accessor :hive_job - # Optional The labels to associate with this job.Label keys must be between 1 + # Optional. The labels to associate with this job.Label keys must be between 1 # and 63 characters long, and must conform to the following regular expression: \ # p`Ll`\p`Lo``0,62`Label values must be between 1 and 63 characters long, and # must conform to the following regular expression: \p`Ll`\p`Lo`\p`N`_-`0,63`No @@ -1518,8 +1520,8 @@ module Google # @return [Google::Apis::DataprocV1beta2::PigJob] attr_accessor :pig_job - # Optional The optional list of prerequisite job step_ids. If not specified, the - # job will start at the beginning of workflow. + # Optional. The optional list of prerequisite job step_ids. If not specified, + # the job will start at the beginning of workflow. # Corresponds to the JSON property `prerequisiteStepIds` # @return [Array] attr_accessor :prerequisite_step_ids @@ -1548,9 +1550,9 @@ module Google # @return [Google::Apis::DataprocV1beta2::SparkSqlJob] attr_accessor :spark_sql_job - # Required The step id. The id must be unique among all jobs within the template. - # The step id is used as prefix for job id, as job workflow-step-id label, and - # in prerequisite_step_ids field from other steps. + # Required. The step id. The id must be unique among all jobs within the + # template.The step id is used as prefix for job id, as job workflow-step-id + # label, and in prerequisite_step_ids field from other steps. # Corresponds to the JSON property `stepId` # @return [String] attr_accessor :step_id @@ -2139,7 +2141,7 @@ module Google class WorkflowGraph include Google::Apis::Core::Hashable - # Output-only The workflow nodes. + # Output only. The workflow nodes. # Corresponds to the JSON property `nodes` # @return [Array] attr_accessor :nodes @@ -2158,17 +2160,17 @@ module Google class WorkflowMetadata include Google::Apis::Core::Hashable - # Output-only The name of the managed cluster. + # Output only. The name of the managed cluster. # Corresponds to the JSON property `clusterName` # @return [String] attr_accessor :cluster_name - # Output-only The create cluster operation metadata. + # Output only. The create cluster operation metadata. # Corresponds to the JSON property `createCluster` # @return [Google::Apis::DataprocV1beta2::ClusterOperation] attr_accessor :create_cluster - # Output-only The delete cluster operation metadata. + # Output only. The delete cluster operation metadata. # Corresponds to the JSON property `deleteCluster` # @return [Google::Apis::DataprocV1beta2::ClusterOperation] attr_accessor :delete_cluster @@ -2178,17 +2180,17 @@ module Google # @return [Google::Apis::DataprocV1beta2::WorkflowGraph] attr_accessor :graph - # Output-only The workflow state. + # Output only. The workflow state. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state - # Output-only The "resource name" of the template. + # Output only. The "resource name" of the template. # Corresponds to the JSON property `template` # @return [String] attr_accessor :template - # Output-only The version of template at the time of workflow instantiation. + # Output only. The version of template at the time of workflow instantiation. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -2213,27 +2215,27 @@ module Google class WorkflowNode include Google::Apis::Core::Hashable - # Output-only The error detail. + # Output only. The error detail. # Corresponds to the JSON property `error` # @return [String] attr_accessor :error - # Output-only The job id; populated after the node enters RUNNING state. + # Output only. The job id; populated after the node enters RUNNING state. # Corresponds to the JSON property `jobId` # @return [String] attr_accessor :job_id - # Output-only Node's prerequisite nodes. + # Output only. Node's prerequisite nodes. # Corresponds to the JSON property `prerequisiteStepIds` # @return [Array] attr_accessor :prerequisite_step_ids - # Output-only The node state. + # Output only. The node state. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state - # Output-only The name of the node. + # Output only. The name of the node. # Corresponds to the JSON property `stepId` # @return [String] attr_accessor :step_id @@ -2256,22 +2258,22 @@ module Google class WorkflowTemplate include Google::Apis::Core::Hashable - # Output-only The time template was created. + # Output only. The time template was created. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # Required The template id. + # Required. The template id. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Required The Directed Acyclic Graph of Jobs to submit. + # Required. The Directed Acyclic Graph of Jobs to submit. # Corresponds to the JSON property `jobs` # @return [Array] attr_accessor :jobs - # Optional The labels to associate with this template. These labels will be + # Optional. The labels to associate with this template. These labels will be # propagated to all jobs and clusters created by the workflow instance.Label # keys must contain 1 to 63 characters, and must conform to RFC 1035 (https:// # www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must @@ -2281,8 +2283,8 @@ module Google # @return [Hash] attr_accessor :labels - # Output-only The "resource name" of the template, as described in https://cloud. - # google.com/apis/design/resource_names of the form projects/`project_id`/ + # Output only. The "resource name" of the template, as described in https:// + # cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # Corresponds to the JSON property `name` # @return [String] @@ -2294,12 +2296,12 @@ module Google # @return [Google::Apis::DataprocV1beta2::WorkflowTemplatePlacement] attr_accessor :placement - # Output-only The time template was last updated. + # Output only. The time template was last updated. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time - # Optional Used to perform a consistent read-modify-write.This field should be + # Optional. Used to perform a consistent read-modify-write.This field should be # left blank for a CreateWorkflowTemplate request. It is required for an # UpdateWorkflowTemplate request, and must match the current server version. A # typical update template flow would fetch the current template with a diff --git a/generated/google/apis/dataproc_v1beta2/service.rb b/generated/google/apis/dataproc_v1beta2/service.rb index 1911cb608..4da5f4d02 100644 --- a/generated/google/apis/dataproc_v1beta2/service.rb +++ b/generated/google/apis/dataproc_v1beta2/service.rb @@ -49,7 +49,7 @@ module Google # Creates new workflow template. # @param [String] parent - # Required The "resource name" of the region, as described in https://cloud. + # Required. The "resource name" of the region, as described in https://cloud. # google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region` # @param [Google::Apis::DataprocV1beta2::WorkflowTemplate] workflow_template_object @@ -84,11 +84,11 @@ module Google # Deletes a workflow template. It does not cancel in-progress workflows. # @param [String] name - # Required The "resource name" of the workflow template, as described in https:// - # cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ + # Required. The "resource name" of the workflow template, as described in https:/ + # /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Fixnum] version - # Optional The version of workflow template to delete. If specified, will only + # Optional. The version of workflow template to delete. If specified, will only # delete the template if the current server version matches specified version. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -121,11 +121,11 @@ module Google # Retrieves the latest workflow template.Can retrieve previously instantiated # template by specifying optional version parameter. # @param [String] name - # Required The "resource name" of the workflow template, as described in https:// - # cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ + # Required. The "resource name" of the workflow template, as described in https:/ + # /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Fixnum] version - # Optional The version of workflow template to retrieve. Only previously + # Optional. The version of workflow template to retrieve. Only previously # instatiated versions can be retrieved.If unspecified, retrieves the current # version. # @param [String] fields @@ -165,8 +165,8 @@ module Google # WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will # always be google.protobuf.Empty. # @param [String] name - # Required The "resource name" of the workflow template, as described in https:// - # cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ + # Required. The "resource name" of the workflow template, as described in https:/ + # /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Google::Apis::DataprocV1beta2::InstantiateWorkflowTemplateRequest] instantiate_workflow_template_request_object # @param [String] fields @@ -200,14 +200,14 @@ module Google # Lists workflows that match the specified filter in the request. # @param [String] parent - # Required The "resource name" of the region, as described in https://cloud. + # Required. The "resource name" of the region, as described in https://cloud. # google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region` # @param [Fixnum] page_size - # Optional The maximum number of results to return in each response. + # Optional. The maximum number of results to return in each response. # @param [String] page_token - # Optional The page token, returned by a previous call, to request the next page - # of results. + # Optional. The page token, returned by a previous call, to request the next + # page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -240,8 +240,8 @@ module Google # Updates (replaces) workflow template. The updated template must contain # version that matches the current server version. # @param [String] name - # Output-only The "resource name" of the template, as described in https://cloud. - # google.com/apis/design/resource_names of the form projects/`project_id`/ + # Output only. The "resource name" of the template, as described in https:// + # cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Google::Apis::DataprocV1beta2::WorkflowTemplate] workflow_template_object # @param [String] fields @@ -788,13 +788,13 @@ module Google # Optional. A filter constraining the jobs to list. Filters are case-sensitive # and have the following syntax:field = value AND field = value ...where field # is status.state or labels.[KEY], and [KEY] is a label key. value can be * to - # match all values. status.state can be either ACTIVE or INACTIVE. Only the + # match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the # logical AND operator is supported; space-separated items are treated as having # an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = # staging AND labels.starred = * # @param [String] job_state_matcher - # Optional. Specifies enumerated categories of jobs to list (default = match ALL - # jobs). + # Optional. Specifies enumerated categories of jobs to list. (default = match + # ALL jobs).If filter is provided, jobStateMatcher will be ignored. # @param [Fixnum] page_size # Optional. The number of results to return in each response. # @param [String] page_token @@ -1064,7 +1064,7 @@ module Google # Creates new workflow template. # @param [String] parent - # Required The "resource name" of the region, as described in https://cloud. + # Required. The "resource name" of the region, as described in https://cloud. # google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region` # @param [Google::Apis::DataprocV1beta2::WorkflowTemplate] workflow_template_object @@ -1099,11 +1099,11 @@ module Google # Deletes a workflow template. It does not cancel in-progress workflows. # @param [String] name - # Required The "resource name" of the workflow template, as described in https:// - # cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ + # Required. The "resource name" of the workflow template, as described in https:/ + # /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Fixnum] version - # Optional The version of workflow template to delete. If specified, will only + # Optional. The version of workflow template to delete. If specified, will only # delete the template if the current server version matches specified version. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1136,11 +1136,11 @@ module Google # Retrieves the latest workflow template.Can retrieve previously instantiated # template by specifying optional version parameter. # @param [String] name - # Required The "resource name" of the workflow template, as described in https:// - # cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ + # Required. The "resource name" of the workflow template, as described in https:/ + # /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Fixnum] version - # Optional The version of workflow template to retrieve. Only previously + # Optional. The version of workflow template to retrieve. Only previously # instatiated versions can be retrieved.If unspecified, retrieves the current # version. # @param [String] fields @@ -1180,8 +1180,8 @@ module Google # WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will # always be google.protobuf.Empty. # @param [String] name - # Required The "resource name" of the workflow template, as described in https:// - # cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ + # Required. The "resource name" of the workflow template, as described in https:/ + # /cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Google::Apis::DataprocV1beta2::InstantiateWorkflowTemplateRequest] instantiate_workflow_template_request_object # @param [String] fields @@ -1215,14 +1215,14 @@ module Google # Lists workflows that match the specified filter in the request. # @param [String] parent - # Required The "resource name" of the region, as described in https://cloud. + # Required. The "resource name" of the region, as described in https://cloud. # google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region` # @param [Fixnum] page_size - # Optional The maximum number of results to return in each response. + # Optional. The maximum number of results to return in each response. # @param [String] page_token - # Optional The page token, returned by a previous call, to request the next page - # of results. + # Optional. The page token, returned by a previous call, to request the next + # page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1255,8 +1255,8 @@ module Google # Updates (replaces) workflow template. The updated template must contain # version that matches the current server version. # @param [String] name - # Output-only The "resource name" of the template, as described in https://cloud. - # google.com/apis/design/resource_names of the form projects/`project_id`/ + # Output only. The "resource name" of the template, as described in https:// + # cloud.google.com/apis/design/resource_names of the form projects/`project_id`/ # regions/`region`/workflowTemplates/`template_id` # @param [Google::Apis::DataprocV1beta2::WorkflowTemplate] workflow_template_object # @param [String] fields diff --git a/generated/google/apis/datastore_v1.rb b/generated/google/apis/datastore_v1.rb index e76798b9d..928c63079 100644 --- a/generated/google/apis/datastore_v1.rb +++ b/generated/google/apis/datastore_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/datastore/ module DatastoreV1 VERSION = 'V1' - REVISION = '20170904' + REVISION = '20171024' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/datastore_v1/classes.rb b/generated/google/apis/datastore_v1/classes.rb index 9743a5801..486b9eac9 100644 --- a/generated/google/apis/datastore_v1/classes.rb +++ b/generated/google/apis/datastore_v1/classes.rb @@ -877,36 +877,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) class LatLng include Google::Apis::Core::Hashable @@ -1475,6 +1445,45 @@ module Google end end + # The request for Datastore.ReserveIds. + class ReserveIdsRequest + include Google::Apis::Core::Hashable + + # If not empty, the ID of the database against which to make the request. + # Corresponds to the JSON property `databaseId` + # @return [String] + attr_accessor :database_id + + # A list of keys with complete key paths whose numeric IDs should not be + # auto-allocated. + # Corresponds to the JSON property `keys` + # @return [Array] + attr_accessor :keys + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @database_id = args[:database_id] if args.key?(:database_id) + @keys = args[:keys] if args.key?(:keys) + end + end + + # The response for Datastore.ReserveIds. + class ReserveIdsResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # The request for Datastore.Rollback. class RollbackRequest include Google::Apis::Core::Hashable @@ -1737,36 +1746,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # Corresponds to the JSON property `geoPointValue` # @return [Google::Apis::DatastoreV1::LatLng] attr_accessor :geo_point_value diff --git a/generated/google/apis/datastore_v1/representations.rb b/generated/google/apis/datastore_v1/representations.rb index b723dc031..dcd65117d 100644 --- a/generated/google/apis/datastore_v1/representations.rb +++ b/generated/google/apis/datastore_v1/representations.rb @@ -262,6 +262,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ReserveIdsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReserveIdsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class RollbackRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -692,6 +704,21 @@ module Google end end + class ReserveIdsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :database_id, as: 'databaseId' + collection :keys, as: 'keys', class: Google::Apis::DatastoreV1::Key, decorator: Google::Apis::DatastoreV1::Key::Representation + + end + end + + class ReserveIdsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class RollbackRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/datastore_v1/service.rb b/generated/google/apis/datastore_v1/service.rb index 042887e14..38e9a5a3c 100644 --- a/generated/google/apis/datastore_v1/service.rb +++ b/generated/google/apis/datastore_v1/service.rb @@ -182,6 +182,40 @@ module Google execute_or_queue_command(command, &block) end + # Prevents the supplied keys' IDs from being auto-allocated by Cloud + # Datastore. + # @param [String] project_id + # The ID of the project against which to make the request. + # @param [Google::Apis::DatastoreV1::ReserveIdsRequest] reserve_ids_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DatastoreV1::ReserveIdsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatastoreV1::ReserveIdsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def reserve_project_ids(project_id, reserve_ids_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/projects/{projectId}:reserveIds', options) + command.request_representation = Google::Apis::DatastoreV1::ReserveIdsRequest::Representation + command.request_object = reserve_ids_request_object + command.response_representation = Google::Apis::DatastoreV1::ReserveIdsResponse::Representation + command.response_class = Google::Apis::DatastoreV1::ReserveIdsResponse + command.params['projectId'] = project_id unless project_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Rolls back a transaction. # @param [String] project_id # The ID of the project against which to make the request. diff --git a/generated/google/apis/datastore_v1beta3.rb b/generated/google/apis/datastore_v1beta3.rb index b46859050..7f6a5f73f 100644 --- a/generated/google/apis/datastore_v1beta3.rb +++ b/generated/google/apis/datastore_v1beta3.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/datastore/ module DatastoreV1beta3 VERSION = 'V1beta3' - REVISION = '20170904' + REVISION = '20171024' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/datastore_v1beta3/classes.rb b/generated/google/apis/datastore_v1beta3/classes.rb index 9fba1baba..b92deadbd 100644 --- a/generated/google/apis/datastore_v1beta3/classes.rb +++ b/generated/google/apis/datastore_v1beta3/classes.rb @@ -736,36 +736,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) class LatLng include Google::Apis::Core::Hashable @@ -1334,6 +1304,45 @@ module Google end end + # The request for Datastore.ReserveIds. + class ReserveIdsRequest + include Google::Apis::Core::Hashable + + # If not empty, the ID of the database against which to make the request. + # Corresponds to the JSON property `databaseId` + # @return [String] + attr_accessor :database_id + + # A list of keys with complete key paths whose numeric IDs should not be + # auto-allocated. + # Corresponds to the JSON property `keys` + # @return [Array] + attr_accessor :keys + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @database_id = args[:database_id] if args.key?(:database_id) + @keys = args[:keys] if args.key?(:keys) + end + end + + # The response for Datastore.ReserveIds. + class ReserveIdsResponse + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # The request for Datastore.Rollback. class RollbackRequest include Google::Apis::Core::Hashable @@ -1524,36 +1533,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # Corresponds to the JSON property `geoPointValue` # @return [Google::Apis::DatastoreV1beta3::LatLng] attr_accessor :geo_point_value diff --git a/generated/google/apis/datastore_v1beta3/representations.rb b/generated/google/apis/datastore_v1beta3/representations.rb index cf6bf66fa..bfaaecdd5 100644 --- a/generated/google/apis/datastore_v1beta3/representations.rb +++ b/generated/google/apis/datastore_v1beta3/representations.rb @@ -244,6 +244,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ReserveIdsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReserveIdsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class RollbackRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -641,6 +653,21 @@ module Google end end + class ReserveIdsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :database_id, as: 'databaseId' + collection :keys, as: 'keys', class: Google::Apis::DatastoreV1beta3::Key, decorator: Google::Apis::DatastoreV1beta3::Key::Representation + + end + end + + class ReserveIdsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class RollbackRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/datastore_v1beta3/service.rb b/generated/google/apis/datastore_v1beta3/service.rb index bddb10121..d84f71fe3 100644 --- a/generated/google/apis/datastore_v1beta3/service.rb +++ b/generated/google/apis/datastore_v1beta3/service.rb @@ -182,6 +182,40 @@ module Google execute_or_queue_command(command, &block) end + # Prevents the supplied keys' IDs from being auto-allocated by Cloud + # Datastore. + # @param [String] project_id + # The ID of the project against which to make the request. + # @param [Google::Apis::DatastoreV1beta3::ReserveIdsRequest] reserve_ids_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DatastoreV1beta3::ReserveIdsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DatastoreV1beta3::ReserveIdsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def reserve_project_ids(project_id, reserve_ids_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta3/projects/{projectId}:reserveIds', options) + command.request_representation = Google::Apis::DatastoreV1beta3::ReserveIdsRequest::Representation + command.request_object = reserve_ids_request_object + command.response_representation = Google::Apis::DatastoreV1beta3::ReserveIdsResponse::Representation + command.response_class = Google::Apis::DatastoreV1beta3::ReserveIdsResponse + command.params['projectId'] = project_id unless project_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Rolls back a transaction. # @param [String] project_id # The ID of the project against which to make the request. diff --git a/generated/google/apis/deploymentmanager_alpha.rb b/generated/google/apis/deploymentmanager_alpha.rb index 8ee152087..b13c65a7b 100644 --- a/generated/google/apis/deploymentmanager_alpha.rb +++ b/generated/google/apis/deploymentmanager_alpha.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/deployment-manager/ module DeploymentmanagerAlpha VERSION = 'Alpha' - REVISION = '20170925' + REVISION = '20171102' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/deploymentmanager_alpha/classes.rb b/generated/google/apis/deploymentmanager_alpha/classes.rb index 36bfbca02..2e56e3d70 100644 --- a/generated/google/apis/deploymentmanager_alpha/classes.rb +++ b/generated/google/apis/deploymentmanager_alpha/classes.rb @@ -22,6 +22,31 @@ module Google module Apis module DeploymentmanagerAlpha + # Async options that determine when a resource should finish. + class AsyncOptions + include Google::Apis::Core::Hashable + + # Method regex where this policy will apply. + # Corresponds to the JSON property `methodMatch` + # @return [String] + attr_accessor :method_match + + # + # Corresponds to the JSON property `pollingOptions` + # @return [Google::Apis::DeploymentmanagerAlpha::PollingOptions] + attr_accessor :polling_options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @method_match = args[:method_match] if args.key?(:method_match) + @polling_options = args[:polling_options] if args.key?(:polling_options) + end + end + # Specifies the audit configuration for a service. The configuration determines # which permission types are logged, and what identities, if any, are exempted # from logging. An AuditConfig must have one or more AuditLogConfigs. @@ -248,7 +273,8 @@ module Google # @return [Array] attr_accessor :labels - # Name of the composite type. + # Name of the composite type, must follow the expression: [a-z]([-a-z0-9_.]`0,61` + # [a-z0-9])?. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -794,6 +820,32 @@ module Google end end + # + class Diagnostic + include Google::Apis::Core::Hashable + + # JsonPath expression on the resource that if non empty, indicates that this + # field needs to be extracted as a diagnostic. + # Corresponds to the JSON property `field` + # @return [String] + attr_accessor :field + + # Level to record this diagnostic. + # Corresponds to the JSON property `level` + # @return [String] + attr_accessor :level + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @field = args[:field] if args.key?(:field) + @level = args[:level] if args.key?(:level) + end + end + # Represents an expression text. Example: # title: "User account presence" description: "Determines whether the request # has a user account" expression: "size(request.user) > 0" @@ -1438,6 +1490,11 @@ module Google class Options include Google::Apis::Core::Hashable + # Options regarding how to thread async requests. + # Corresponds to the JSON property `asyncOptions` + # @return [Array] + attr_accessor :async_options + # The mappings that apply for requests. # Corresponds to the JSON property `inputMappings` # @return [Array] @@ -1461,6 +1518,7 @@ module Google # Update properties of this object def update!(**args) + @async_options = args[:async_options] if args.key?(:async_options) @input_mappings = args[:input_mappings] if args.key?(:input_mappings) @name_property = args[:name_property] if args.key?(:name_property) @validation_options = args[:validation_options] if args.key?(:validation_options) @@ -1545,6 +1603,51 @@ module Google end end + # + class PollingOptions + include Google::Apis::Core::Hashable + + # An array of diagnostics to be collected by Deployment Manager, these + # diagnostics will be displayed to the user. + # Corresponds to the JSON property `diagnostics` + # @return [Array] + attr_accessor :diagnostics + + # JsonPath expression that determines if the request failed. + # Corresponds to the JSON property `failCondition` + # @return [String] + attr_accessor :fail_condition + + # JsonPath expression that determines if the request is completed. + # Corresponds to the JSON property `finishCondition` + # @return [String] + attr_accessor :finish_condition + + # JsonPath expression that evaluates to string, it indicates where to poll. + # Corresponds to the JSON property `pollingLink` + # @return [String] + attr_accessor :polling_link + + # JsonPath expression, after polling is completed, indicates where to fetch the + # resource. + # Corresponds to the JSON property `targetLink` + # @return [String] + attr_accessor :target_link + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @diagnostics = args[:diagnostics] if args.key?(:diagnostics) + @fail_condition = args[:fail_condition] if args.key?(:fail_condition) + @finish_condition = args[:finish_condition] if args.key?(:finish_condition) + @polling_link = args[:polling_link] if args.key?(:polling_link) + @target_link = args[:target_link] if args.key?(:target_link) + end + end + # class Resource include Google::Apis::Core::Hashable @@ -2063,6 +2166,11 @@ module Google # @return [String] attr_accessor :interpreter + # The filename of the mainTemplate + # Corresponds to the JSON property `mainTemplate` + # @return [String] + attr_accessor :main_template + # The contents of the template schema. # Corresponds to the JSON property `schema` # @return [String] @@ -2081,6 +2189,7 @@ module Google def update!(**args) @imports = args[:imports] if args.key?(:imports) @interpreter = args[:interpreter] if args.key?(:interpreter) + @main_template = args[:main_template] if args.key?(:main_template) @schema = args[:schema] if args.key?(:schema) @template = args[:template] if args.key?(:template) end diff --git a/generated/google/apis/deploymentmanager_alpha/representations.rb b/generated/google/apis/deploymentmanager_alpha/representations.rb index 08cd368eb..57adae70c 100644 --- a/generated/google/apis/deploymentmanager_alpha/representations.rb +++ b/generated/google/apis/deploymentmanager_alpha/representations.rb @@ -22,6 +22,12 @@ module Google module Apis module DeploymentmanagerAlpha + class AsyncOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AuditConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -148,6 +154,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Diagnostic + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Expr class Representation < Google::Apis::Core::JsonRepresentation; end @@ -250,6 +262,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PollingOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Resource class Representation < Google::Apis::Core::JsonRepresentation; end @@ -406,6 +424,15 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class AsyncOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :method_match, as: 'methodMatch' + property :polling_options, as: 'pollingOptions', class: Google::Apis::DeploymentmanagerAlpha::PollingOptions, decorator: Google::Apis::DeploymentmanagerAlpha::PollingOptions::Representation + + end + end + class AuditConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -620,6 +647,14 @@ module Google end end + class Diagnostic + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :field, as: 'field' + property :level, as: 'level' + end + end + class Expr # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -787,6 +822,8 @@ module Google class Options # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :async_options, as: 'asyncOptions', class: Google::Apis::DeploymentmanagerAlpha::AsyncOptions, decorator: Google::Apis::DeploymentmanagerAlpha::AsyncOptions::Representation + collection :input_mappings, as: 'inputMappings', class: Google::Apis::DeploymentmanagerAlpha::InputMapping, decorator: Google::Apis::DeploymentmanagerAlpha::InputMapping::Representation property :name_property, as: 'nameProperty' @@ -810,6 +847,18 @@ module Google end end + class PollingOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :diagnostics, as: 'diagnostics', class: Google::Apis::DeploymentmanagerAlpha::Diagnostic, decorator: Google::Apis::DeploymentmanagerAlpha::Diagnostic::Representation + + property :fail_condition, as: 'failCondition' + property :finish_condition, as: 'finishCondition' + property :polling_link, as: 'pollingLink' + property :target_link, as: 'targetLink' + end + end + class Resource # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -959,6 +1008,7 @@ module Google collection :imports, as: 'imports', class: Google::Apis::DeploymentmanagerAlpha::ImportFile, decorator: Google::Apis::DeploymentmanagerAlpha::ImportFile::Representation property :interpreter, as: 'interpreter' + property :main_template, as: 'mainTemplate' property :schema, as: 'schema' property :template, as: 'template' end diff --git a/generated/google/apis/deploymentmanager_v2beta.rb b/generated/google/apis/deploymentmanager_v2beta.rb index 0587bb7c0..ca8bcab5b 100644 --- a/generated/google/apis/deploymentmanager_v2beta.rb +++ b/generated/google/apis/deploymentmanager_v2beta.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/deployment-manager/ module DeploymentmanagerV2beta VERSION = 'V2beta' - REVISION = '20170925' + REVISION = '20171102' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/deploymentmanager_v2beta/classes.rb b/generated/google/apis/deploymentmanager_v2beta/classes.rb index a6f71f475..9c94445c8 100644 --- a/generated/google/apis/deploymentmanager_v2beta/classes.rb +++ b/generated/google/apis/deploymentmanager_v2beta/classes.rb @@ -286,7 +286,8 @@ module Google # @return [Array] attr_accessor :labels - # Name of the composite type. + # Name of the composite type, must follow the expression: [a-z]([-a-z0-9_.]`0,61` + # [a-z0-9])?. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2008,6 +2009,11 @@ module Google # @return [String] attr_accessor :interpreter + # The filename of the mainTemplate + # Corresponds to the JSON property `mainTemplate` + # @return [String] + attr_accessor :main_template + # The contents of the template schema. # Corresponds to the JSON property `schema` # @return [String] @@ -2026,6 +2032,7 @@ module Google def update!(**args) @imports = args[:imports] if args.key?(:imports) @interpreter = args[:interpreter] if args.key?(:interpreter) + @main_template = args[:main_template] if args.key?(:main_template) @schema = args[:schema] if args.key?(:schema) @template = args[:template] if args.key?(:template) end diff --git a/generated/google/apis/deploymentmanager_v2beta/representations.rb b/generated/google/apis/deploymentmanager_v2beta/representations.rb index 8e97af97c..4051cc378 100644 --- a/generated/google/apis/deploymentmanager_v2beta/representations.rb +++ b/generated/google/apis/deploymentmanager_v2beta/representations.rb @@ -935,6 +935,7 @@ module Google collection :imports, as: 'imports', class: Google::Apis::DeploymentmanagerV2beta::ImportFile, decorator: Google::Apis::DeploymentmanagerV2beta::ImportFile::Representation property :interpreter, as: 'interpreter' + property :main_template, as: 'mainTemplate' property :schema, as: 'schema' property :template, as: 'template' end diff --git a/generated/google/apis/dfareporting_v2_7.rb b/generated/google/apis/dfareporting_v2_7.rb index 7f62fe574..eaab2c3ab 100644 --- a/generated/google/apis/dfareporting_v2_7.rb +++ b/generated/google/apis/dfareporting_v2_7.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/doubleclick-advertisers/ module DfareportingV2_7 VERSION = 'V2_7' - REVISION = '20170818' + REVISION = '20171109' # Manage DoubleClick Digital Marketing conversions AUTH_DDMCONVERSIONS = 'https://www.googleapis.com/auth/ddmconversions' diff --git a/generated/google/apis/dfareporting_v2_7/classes.rb b/generated/google/apis/dfareporting_v2_7/classes.rb index cefc2a7ad..daee9953c 100644 --- a/generated/google/apis/dfareporting_v2_7/classes.rb +++ b/generated/google/apis/dfareporting_v2_7/classes.rb @@ -114,6 +114,7 @@ module Google # - "47" for BGN # - "48" for HRK # - "49" for MXN + # - "50" for NGN # Corresponds to the JSON property `currencyId` # @return [Fixnum] attr_accessor :currency_id @@ -2669,7 +2670,7 @@ module Google attr_accessor :background_color # Click-through URL for backup image. Applicable to the following creative types: - # FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset + # FLASH_INPAGE, and HTML5_BANNER. Applicable to DISPLAY when the primary asset # type is not HTML_IMAGE. # Corresponds to the JSON property `backupImageClickThroughUrl` # @return [String] @@ -4837,6 +4838,7 @@ module Google # - "47" for BGN # - "48" for HRK # - "49" for MXN + # - "50" for NGN # Corresponds to the JSON property `currencyId` # @return [Fixnum] attr_accessor :currency_id @@ -5638,7 +5640,8 @@ module Google class FloodlightActivitiesGenerateTagResponse include Google::Apis::Core::Hashable - # Generated tag for this floodlight activity. + # Generated tag for this Floodlight activity. For global site tags, this is the + # event snippet. # Corresponds to the JSON property `floodlightActivityTag` # @return [String] attr_accessor :floodlight_activity_tag @@ -5848,7 +5851,7 @@ module Google # @return [String] attr_accessor :tag_format - # Value of the cat= paramter in the floodlight tag, which the ad servers use to + # Value of the cat= parameter in the floodlight tag, which the ad servers use to # identify the activity. This is optional: if empty, a new tag string will be # generated for you. This string must be 1 to 8 characters long, with valid # characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique diff --git a/generated/google/apis/dfareporting_v2_8.rb b/generated/google/apis/dfareporting_v2_8.rb index 39770bbe3..7f859e6cc 100644 --- a/generated/google/apis/dfareporting_v2_8.rb +++ b/generated/google/apis/dfareporting_v2_8.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/doubleclick-advertisers/ module DfareportingV2_8 VERSION = 'V2_8' - REVISION = '20170818' + REVISION = '20171109' # Manage DoubleClick Digital Marketing conversions AUTH_DDMCONVERSIONS = 'https://www.googleapis.com/auth/ddmconversions' diff --git a/generated/google/apis/dfareporting_v2_8/classes.rb b/generated/google/apis/dfareporting_v2_8/classes.rb index f41208dd0..99d152e67 100644 --- a/generated/google/apis/dfareporting_v2_8/classes.rb +++ b/generated/google/apis/dfareporting_v2_8/classes.rb @@ -114,6 +114,7 @@ module Google # - "47" for BGN # - "48" for HRK # - "49" for MXN + # - "50" for NGN # Corresponds to the JSON property `currencyId` # @return [Fixnum] attr_accessor :currency_id @@ -2797,7 +2798,7 @@ module Google attr_accessor :background_color # Click-through URL for backup image. Applicable to the following creative types: - # FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the primary asset + # FLASH_INPAGE, and HTML5_BANNER. Applicable to DISPLAY when the primary asset # type is not HTML_IMAGE. # Corresponds to the JSON property `backupImageClickThroughUrl` # @return [String] @@ -4972,6 +4973,7 @@ module Google # - "47" for BGN # - "48" for HRK # - "49" for MXN + # - "50" for NGN # Corresponds to the JSON property `currencyId` # @return [Fixnum] attr_accessor :currency_id @@ -5773,7 +5775,8 @@ module Google class FloodlightActivitiesGenerateTagResponse include Google::Apis::Core::Hashable - # Generated tag for this floodlight activity. + # Generated tag for this Floodlight activity. For global site tags, this is the + # event snippet. # Corresponds to the JSON property `floodlightActivityTag` # @return [String] attr_accessor :floodlight_activity_tag @@ -5983,7 +5986,7 @@ module Google # @return [String] attr_accessor :tag_format - # Value of the cat= paramter in the floodlight tag, which the ad servers use to + # Value of the cat= parameter in the floodlight tag, which the ad servers use to # identify the activity. This is optional: if empty, a new tag string will be # generated for you. This string must be 1 to 8 characters long, with valid # characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique @@ -10180,8 +10183,8 @@ module Google attr_accessor :dimensions # Whether to enable all reach dimension combinations in the report. Defaults to - # false. If enabled, the date range of the report should be within the last - # three months. + # false. If enabled, the date range of the report should be within the last 42 + # days. # Corresponds to the JSON property `enableAllDimensionCombinations` # @return [Boolean] attr_accessor :enable_all_dimension_combinations diff --git a/generated/google/apis/dfareporting_v3_0.rb b/generated/google/apis/dfareporting_v3_0.rb new file mode 100644 index 000000000..88bdb469d --- /dev/null +++ b/generated/google/apis/dfareporting_v3_0.rb @@ -0,0 +1,40 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/dfareporting_v3_0/service.rb' +require 'google/apis/dfareporting_v3_0/classes.rb' +require 'google/apis/dfareporting_v3_0/representations.rb' + +module Google + module Apis + # DCM/DFA Reporting And Trafficking API + # + # Manages your DoubleClick Campaign Manager ad campaigns and reports. + # + # @see https://developers.google.com/doubleclick-advertisers/ + module DfareportingV3_0 + VERSION = 'V3_0' + REVISION = '20171109' + + # Manage DoubleClick Digital Marketing conversions + AUTH_DDMCONVERSIONS = 'https://www.googleapis.com/auth/ddmconversions' + + # View and manage DoubleClick for Advertisers reports + AUTH_DFAREPORTING = 'https://www.googleapis.com/auth/dfareporting' + + # View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns + AUTH_DFATRAFFICKING = 'https://www.googleapis.com/auth/dfatrafficking' + end + end +end diff --git a/generated/google/apis/dfareporting_v3_0/classes.rb b/generated/google/apis/dfareporting_v3_0/classes.rb new file mode 100644 index 000000000..91a4f2e7b --- /dev/null +++ b/generated/google/apis/dfareporting_v3_0/classes.rb @@ -0,0 +1,12117 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DfareportingV3_0 + + # Contains properties of a DCM account. + class Account + include Google::Apis::Core::Hashable + + # Account permissions assigned to this account. + # Corresponds to the JSON property `accountPermissionIds` + # @return [Array] + attr_accessor :account_permission_ids + + # Profile for this account. This is a read-only field that can be left blank. + # Corresponds to the JSON property `accountProfile` + # @return [String] + attr_accessor :account_profile + + # Whether this account is active. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Maximum number of active ads allowed for this account. + # Corresponds to the JSON property `activeAdsLimitTier` + # @return [String] + attr_accessor :active_ads_limit_tier + + # Whether to serve creatives with Active View tags. If disabled, viewability + # data will not be available for any impressions. + # Corresponds to the JSON property `activeViewOptOut` + # @return [Boolean] + attr_accessor :active_view_opt_out + alias_method :active_view_opt_out?, :active_view_opt_out + + # User role permissions available to the user roles of this account. + # Corresponds to the JSON property `availablePermissionIds` + # @return [Array] + attr_accessor :available_permission_ids + + # ID of the country associated with this account. + # Corresponds to the JSON property `countryId` + # @return [Fixnum] + attr_accessor :country_id + + # ID of currency associated with this account. This is a required field. + # Acceptable values are: + # - "1" for USD + # - "2" for GBP + # - "3" for ESP + # - "4" for SEK + # - "5" for CAD + # - "6" for JPY + # - "7" for DEM + # - "8" for AUD + # - "9" for FRF + # - "10" for ITL + # - "11" for DKK + # - "12" for NOK + # - "13" for FIM + # - "14" for ZAR + # - "15" for IEP + # - "16" for NLG + # - "17" for EUR + # - "18" for KRW + # - "19" for TWD + # - "20" for SGD + # - "21" for CNY + # - "22" for HKD + # - "23" for NZD + # - "24" for MYR + # - "25" for BRL + # - "26" for PTE + # - "27" for MXP + # - "28" for CLP + # - "29" for TRY + # - "30" for ARS + # - "31" for PEN + # - "32" for ILS + # - "33" for CHF + # - "34" for VEF + # - "35" for COP + # - "36" for GTQ + # - "37" for PLN + # - "39" for INR + # - "40" for THB + # - "41" for IDR + # - "42" for CZK + # - "43" for RON + # - "44" for HUF + # - "45" for RUB + # - "46" for AED + # - "47" for BGN + # - "48" for HRK + # - "49" for MXN + # - "50" for NGN + # Corresponds to the JSON property `currencyId` + # @return [Fixnum] + attr_accessor :currency_id + + # Default placement dimensions for this account. + # Corresponds to the JSON property `defaultCreativeSizeId` + # @return [Fixnum] + attr_accessor :default_creative_size_id + + # Description of this account. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # ID of this account. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#account". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Locale of this account. + # Acceptable values are: + # - "cs" (Czech) + # - "de" (German) + # - "en" (English) + # - "en-GB" (English United Kingdom) + # - "es" (Spanish) + # - "fr" (French) + # - "it" (Italian) + # - "ja" (Japanese) + # - "ko" (Korean) + # - "pl" (Polish) + # - "pt-BR" (Portuguese Brazil) + # - "ru" (Russian) + # - "sv" (Swedish) + # - "tr" (Turkish) + # - "zh-CN" (Chinese Simplified) + # - "zh-TW" (Chinese Traditional) + # Corresponds to the JSON property `locale` + # @return [String] + attr_accessor :locale + + # Maximum image size allowed for this account, in kilobytes. Value must be + # greater than or equal to 1. + # Corresponds to the JSON property `maximumImageSize` + # @return [Fixnum] + attr_accessor :maximum_image_size + + # Name of this account. This is a required field, and must be less than 128 + # characters long and be globally unique. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Whether campaigns created in this account will be enabled for Nielsen OCR + # reach ratings by default. + # Corresponds to the JSON property `nielsenOcrEnabled` + # @return [Boolean] + attr_accessor :nielsen_ocr_enabled + alias_method :nielsen_ocr_enabled?, :nielsen_ocr_enabled + + # Reporting Configuration + # Corresponds to the JSON property `reportsConfiguration` + # @return [Google::Apis::DfareportingV3_0::ReportsConfiguration] + attr_accessor :reports_configuration + + # Share Path to Conversion reports with Twitter. + # Corresponds to the JSON property `shareReportsWithTwitter` + # @return [Boolean] + attr_accessor :share_reports_with_twitter + alias_method :share_reports_with_twitter?, :share_reports_with_twitter + + # File size limit in kilobytes of Rich Media teaser creatives. Acceptable values + # are 1 to 10240, inclusive. + # Corresponds to the JSON property `teaserSizeLimit` + # @return [Fixnum] + attr_accessor :teaser_size_limit + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_permission_ids = args[:account_permission_ids] if args.key?(:account_permission_ids) + @account_profile = args[:account_profile] if args.key?(:account_profile) + @active = args[:active] if args.key?(:active) + @active_ads_limit_tier = args[:active_ads_limit_tier] if args.key?(:active_ads_limit_tier) + @active_view_opt_out = args[:active_view_opt_out] if args.key?(:active_view_opt_out) + @available_permission_ids = args[:available_permission_ids] if args.key?(:available_permission_ids) + @country_id = args[:country_id] if args.key?(:country_id) + @currency_id = args[:currency_id] if args.key?(:currency_id) + @default_creative_size_id = args[:default_creative_size_id] if args.key?(:default_creative_size_id) + @description = args[:description] if args.key?(:description) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @locale = args[:locale] if args.key?(:locale) + @maximum_image_size = args[:maximum_image_size] if args.key?(:maximum_image_size) + @name = args[:name] if args.key?(:name) + @nielsen_ocr_enabled = args[:nielsen_ocr_enabled] if args.key?(:nielsen_ocr_enabled) + @reports_configuration = args[:reports_configuration] if args.key?(:reports_configuration) + @share_reports_with_twitter = args[:share_reports_with_twitter] if args.key?(:share_reports_with_twitter) + @teaser_size_limit = args[:teaser_size_limit] if args.key?(:teaser_size_limit) + end + end + + # Gets a summary of active ads in an account. + class AccountActiveAdSummary + include Google::Apis::Core::Hashable + + # ID of the account. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Ads that have been activated for the account + # Corresponds to the JSON property `activeAds` + # @return [Fixnum] + attr_accessor :active_ads + + # Maximum number of active ads allowed for the account. + # Corresponds to the JSON property `activeAdsLimitTier` + # @return [String] + attr_accessor :active_ads_limit_tier + + # Ads that can be activated for the account. + # Corresponds to the JSON property `availableAds` + # @return [Fixnum] + attr_accessor :available_ads + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountActiveAdSummary". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @active_ads = args[:active_ads] if args.key?(:active_ads) + @active_ads_limit_tier = args[:active_ads_limit_tier] if args.key?(:active_ads_limit_tier) + @available_ads = args[:available_ads] if args.key?(:available_ads) + @kind = args[:kind] if args.key?(:kind) + end + end + + # AccountPermissions contains information about a particular account permission. + # Some features of DCM require an account permission to be present in the + # account. + class AccountPermission + include Google::Apis::Core::Hashable + + # Account profiles associated with this account permission. + # Possible values are: + # - "ACCOUNT_PROFILE_BASIC" + # - "ACCOUNT_PROFILE_STANDARD" + # Corresponds to the JSON property `accountProfiles` + # @return [Array] + attr_accessor :account_profiles + + # ID of this account permission. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountPermission". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Administrative level required to enable this account permission. + # Corresponds to the JSON property `level` + # @return [String] + attr_accessor :level + + # Name of this account permission. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Permission group of this account permission. + # Corresponds to the JSON property `permissionGroupId` + # @return [Fixnum] + attr_accessor :permission_group_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_profiles = args[:account_profiles] if args.key?(:account_profiles) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @level = args[:level] if args.key?(:level) + @name = args[:name] if args.key?(:name) + @permission_group_id = args[:permission_group_id] if args.key?(:permission_group_id) + end + end + + # AccountPermissionGroups contains a mapping of permission group IDs to names. A + # permission group is a grouping of account permissions. + class AccountPermissionGroup + include Google::Apis::Core::Hashable + + # ID of this account permission group. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountPermissionGroup". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this account permission group. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Account Permission Group List Response + class AccountPermissionGroupsListResponse + include Google::Apis::Core::Hashable + + # Account permission group collection. + # Corresponds to the JSON property `accountPermissionGroups` + # @return [Array] + attr_accessor :account_permission_groups + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountPermissionGroupsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_permission_groups = args[:account_permission_groups] if args.key?(:account_permission_groups) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Account Permission List Response + class AccountPermissionsListResponse + include Google::Apis::Core::Hashable + + # Account permission collection. + # Corresponds to the JSON property `accountPermissions` + # @return [Array] + attr_accessor :account_permissions + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountPermissionsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_permissions = args[:account_permissions] if args.key?(:account_permissions) + @kind = args[:kind] if args.key?(:kind) + end + end + + # AccountUserProfiles contains properties of a DCM user profile. This resource + # is specifically for managing user profiles, whereas UserProfiles is for + # accessing the API. + class AccountUserProfile + include Google::Apis::Core::Hashable + + # Account ID of the user profile. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Whether this user profile is active. This defaults to false, and must be set + # true on insert for the user profile to be usable. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Object Filter. + # Corresponds to the JSON property `advertiserFilter` + # @return [Google::Apis::DfareportingV3_0::ObjectFilter] + attr_accessor :advertiser_filter + + # Object Filter. + # Corresponds to the JSON property `campaignFilter` + # @return [Google::Apis::DfareportingV3_0::ObjectFilter] + attr_accessor :campaign_filter + + # Comments for this user profile. + # Corresponds to the JSON property `comments` + # @return [String] + attr_accessor :comments + + # Email of the user profile. The email addresss must be linked to a Google + # Account. This field is required on insertion and is read-only after insertion. + # Corresponds to the JSON property `email` + # @return [String] + attr_accessor :email + + # ID of the user profile. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountUserProfile". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Locale of the user profile. This is a required field. + # Acceptable values are: + # - "cs" (Czech) + # - "de" (German) + # - "en" (English) + # - "en-GB" (English United Kingdom) + # - "es" (Spanish) + # - "fr" (French) + # - "it" (Italian) + # - "ja" (Japanese) + # - "ko" (Korean) + # - "pl" (Polish) + # - "pt-BR" (Portuguese Brazil) + # - "ru" (Russian) + # - "sv" (Swedish) + # - "tr" (Turkish) + # - "zh-CN" (Chinese Simplified) + # - "zh-TW" (Chinese Traditional) + # Corresponds to the JSON property `locale` + # @return [String] + attr_accessor :locale + + # Name of the user profile. This is a required field. Must be less than 64 + # characters long, must be globally unique, and cannot contain whitespace or any + # of the following characters: "&;"#%,". + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Object Filter. + # Corresponds to the JSON property `siteFilter` + # @return [Google::Apis::DfareportingV3_0::ObjectFilter] + attr_accessor :site_filter + + # Subaccount ID of the user profile. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Trafficker type of this user profile. + # Corresponds to the JSON property `traffickerType` + # @return [String] + attr_accessor :trafficker_type + + # User type of the user profile. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `userAccessType` + # @return [String] + attr_accessor :user_access_type + + # Object Filter. + # Corresponds to the JSON property `userRoleFilter` + # @return [Google::Apis::DfareportingV3_0::ObjectFilter] + attr_accessor :user_role_filter + + # User role ID of the user profile. This is a required field. + # Corresponds to the JSON property `userRoleId` + # @return [Fixnum] + attr_accessor :user_role_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @active = args[:active] if args.key?(:active) + @advertiser_filter = args[:advertiser_filter] if args.key?(:advertiser_filter) + @campaign_filter = args[:campaign_filter] if args.key?(:campaign_filter) + @comments = args[:comments] if args.key?(:comments) + @email = args[:email] if args.key?(:email) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @locale = args[:locale] if args.key?(:locale) + @name = args[:name] if args.key?(:name) + @site_filter = args[:site_filter] if args.key?(:site_filter) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @trafficker_type = args[:trafficker_type] if args.key?(:trafficker_type) + @user_access_type = args[:user_access_type] if args.key?(:user_access_type) + @user_role_filter = args[:user_role_filter] if args.key?(:user_role_filter) + @user_role_id = args[:user_role_id] if args.key?(:user_role_id) + end + end + + # Account User Profile List Response + class AccountUserProfilesListResponse + include Google::Apis::Core::Hashable + + # Account user profile collection. + # Corresponds to the JSON property `accountUserProfiles` + # @return [Array] + attr_accessor :account_user_profiles + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountUserProfilesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_user_profiles = args[:account_user_profiles] if args.key?(:account_user_profiles) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Account List Response + class AccountsListResponse + include Google::Apis::Core::Hashable + + # Account collection. + # Corresponds to the JSON property `accounts` + # @return [Array] + attr_accessor :accounts + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#accountsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @accounts = args[:accounts] if args.key?(:accounts) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Represents an activity group. + class Activities + include Google::Apis::Core::Hashable + + # List of activity filters. The dimension values need to be all either of type " + # dfa:activity" or "dfa:activityGroup". + # Corresponds to the JSON property `filters` + # @return [Array] + attr_accessor :filters + + # The kind of resource this is, in this case dfareporting#activities. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # List of names of floodlight activity metrics. + # Corresponds to the JSON property `metricNames` + # @return [Array] + attr_accessor :metric_names + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filters = args[:filters] if args.key?(:filters) + @kind = args[:kind] if args.key?(:kind) + @metric_names = args[:metric_names] if args.key?(:metric_names) + end + end + + # Contains properties of a DCM ad. + class Ad + include Google::Apis::Core::Hashable + + # Account ID of this ad. This is a read-only field that can be left blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Whether this ad is active. When true, archived must be false. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Advertiser ID of this ad. This is a required field on insertion. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Whether this ad is archived. When true, active must be false. + # Corresponds to the JSON property `archived` + # @return [Boolean] + attr_accessor :archived + alias_method :archived?, :archived + + # Audience segment ID that is being targeted for this ad. Applicable when type + # is AD_SERVING_STANDARD_AD. + # Corresponds to the JSON property `audienceSegmentId` + # @return [Fixnum] + attr_accessor :audience_segment_id + + # Campaign ID of this ad. This is a required field on insertion. + # Corresponds to the JSON property `campaignId` + # @return [Fixnum] + attr_accessor :campaign_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `campaignIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :campaign_id_dimension_value + + # Click-through URL + # Corresponds to the JSON property `clickThroughUrl` + # @return [Google::Apis::DfareportingV3_0::ClickThroughUrl] + attr_accessor :click_through_url + + # Click Through URL Suffix settings. + # Corresponds to the JSON property `clickThroughUrlSuffixProperties` + # @return [Google::Apis::DfareportingV3_0::ClickThroughUrlSuffixProperties] + attr_accessor :click_through_url_suffix_properties + + # Comments for this ad. + # Corresponds to the JSON property `comments` + # @return [String] + attr_accessor :comments + + # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. + # DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on + # mobile devices or in mobile apps for regular or interstitial ads, respectively. + # APP and APP_INTERSTITIAL are only used for existing default ads. New mobile + # placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads + # created for those placements will be limited to those compatibility types. + # IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the + # VAST standard. + # Corresponds to the JSON property `compatibility` + # @return [String] + attr_accessor :compatibility + + # Modification timestamp. + # Corresponds to the JSON property `createInfo` + # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] + attr_accessor :create_info + + # Creative group assignments for this ad. Applicable when type is + # AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number is + # allowed for a maximum of two assignments. + # Corresponds to the JSON property `creativeGroupAssignments` + # @return [Array] + attr_accessor :creative_group_assignments + + # Creative Rotation. + # Corresponds to the JSON property `creativeRotation` + # @return [Google::Apis::DfareportingV3_0::CreativeRotation] + attr_accessor :creative_rotation + + # Day Part Targeting. + # Corresponds to the JSON property `dayPartTargeting` + # @return [Google::Apis::DfareportingV3_0::DayPartTargeting] + attr_accessor :day_part_targeting + + # Properties of inheriting and overriding the default click-through event tag. A + # campaign may override the event tag defined at the advertiser level, and an ad + # may also override the campaign's setting further. + # Corresponds to the JSON property `defaultClickThroughEventTagProperties` + # @return [Google::Apis::DfareportingV3_0::DefaultClickThroughEventTagProperties] + attr_accessor :default_click_through_event_tag_properties + + # Delivery Schedule. + # Corresponds to the JSON property `deliverySchedule` + # @return [Google::Apis::DfareportingV3_0::DeliverySchedule] + attr_accessor :delivery_schedule + + # Whether this ad is a dynamic click tracker. Applicable when type is + # AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is read-only + # after insert. + # Corresponds to the JSON property `dynamicClickTracker` + # @return [Boolean] + attr_accessor :dynamic_click_tracker + alias_method :dynamic_click_tracker?, :dynamic_click_tracker + + # Date and time that this ad should stop serving. Must be later than the start + # time. This is a required field on insertion. + # Corresponds to the JSON property `endTime` + # @return [DateTime] + attr_accessor :end_time + + # Event tag overrides for this ad. + # Corresponds to the JSON property `eventTagOverrides` + # @return [Array] + attr_accessor :event_tag_overrides + + # Geographical Targeting. + # Corresponds to the JSON property `geoTargeting` + # @return [Google::Apis::DfareportingV3_0::GeoTargeting] + attr_accessor :geo_targeting + + # ID of this ad. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :id_dimension_value + + # Key Value Targeting Expression. + # Corresponds to the JSON property `keyValueTargetingExpression` + # @return [Google::Apis::DfareportingV3_0::KeyValueTargetingExpression] + attr_accessor :key_value_targeting_expression + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#ad". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Language Targeting. + # Corresponds to the JSON property `languageTargeting` + # @return [Google::Apis::DfareportingV3_0::LanguageTargeting] + attr_accessor :language_targeting + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] + attr_accessor :last_modified_info + + # Name of this ad. This is a required field and must be less than 256 characters + # long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Placement assignments for this ad. + # Corresponds to the JSON property `placementAssignments` + # @return [Array] + attr_accessor :placement_assignments + + # Remarketing List Targeting Expression. + # Corresponds to the JSON property `remarketingListExpression` + # @return [Google::Apis::DfareportingV3_0::ListTargetingExpression] + attr_accessor :remarketing_list_expression + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `size` + # @return [Google::Apis::DfareportingV3_0::Size] + attr_accessor :size + + # Whether this ad is ssl compliant. This is a read-only field that is auto- + # generated when the ad is inserted or updated. + # Corresponds to the JSON property `sslCompliant` + # @return [Boolean] + attr_accessor :ssl_compliant + alias_method :ssl_compliant?, :ssl_compliant + + # Whether this ad requires ssl. This is a read-only field that is auto-generated + # when the ad is inserted or updated. + # Corresponds to the JSON property `sslRequired` + # @return [Boolean] + attr_accessor :ssl_required + alias_method :ssl_required?, :ssl_required + + # Date and time that this ad should start serving. If creating an ad, this field + # must be a time in the future. This is a required field on insertion. + # Corresponds to the JSON property `startTime` + # @return [DateTime] + attr_accessor :start_time + + # Subaccount ID of this ad. This is a read-only field that can be left blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Targeting template ID, used to apply preconfigured targeting information to + # this ad. This cannot be set while any of dayPartTargeting, geoTargeting, + # keyValueTargetingExpression, languageTargeting, remarketingListExpression, or + # technologyTargeting are set. Applicable when type is AD_SERVING_STANDARD_AD. + # Corresponds to the JSON property `targetingTemplateId` + # @return [Fixnum] + attr_accessor :targeting_template_id + + # Technology Targeting. + # Corresponds to the JSON property `technologyTargeting` + # @return [Google::Apis::DfareportingV3_0::TechnologyTargeting] + attr_accessor :technology_targeting + + # Type of ad. This is a required field on insertion. Note that default ads ( + # AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative resource). + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @active = args[:active] if args.key?(:active) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @archived = args[:archived] if args.key?(:archived) + @audience_segment_id = args[:audience_segment_id] if args.key?(:audience_segment_id) + @campaign_id = args[:campaign_id] if args.key?(:campaign_id) + @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) + @click_through_url = args[:click_through_url] if args.key?(:click_through_url) + @click_through_url_suffix_properties = args[:click_through_url_suffix_properties] if args.key?(:click_through_url_suffix_properties) + @comments = args[:comments] if args.key?(:comments) + @compatibility = args[:compatibility] if args.key?(:compatibility) + @create_info = args[:create_info] if args.key?(:create_info) + @creative_group_assignments = args[:creative_group_assignments] if args.key?(:creative_group_assignments) + @creative_rotation = args[:creative_rotation] if args.key?(:creative_rotation) + @day_part_targeting = args[:day_part_targeting] if args.key?(:day_part_targeting) + @default_click_through_event_tag_properties = args[:default_click_through_event_tag_properties] if args.key?(:default_click_through_event_tag_properties) + @delivery_schedule = args[:delivery_schedule] if args.key?(:delivery_schedule) + @dynamic_click_tracker = args[:dynamic_click_tracker] if args.key?(:dynamic_click_tracker) + @end_time = args[:end_time] if args.key?(:end_time) + @event_tag_overrides = args[:event_tag_overrides] if args.key?(:event_tag_overrides) + @geo_targeting = args[:geo_targeting] if args.key?(:geo_targeting) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @key_value_targeting_expression = args[:key_value_targeting_expression] if args.key?(:key_value_targeting_expression) + @kind = args[:kind] if args.key?(:kind) + @language_targeting = args[:language_targeting] if args.key?(:language_targeting) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @name = args[:name] if args.key?(:name) + @placement_assignments = args[:placement_assignments] if args.key?(:placement_assignments) + @remarketing_list_expression = args[:remarketing_list_expression] if args.key?(:remarketing_list_expression) + @size = args[:size] if args.key?(:size) + @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) + @ssl_required = args[:ssl_required] if args.key?(:ssl_required) + @start_time = args[:start_time] if args.key?(:start_time) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @targeting_template_id = args[:targeting_template_id] if args.key?(:targeting_template_id) + @technology_targeting = args[:technology_targeting] if args.key?(:technology_targeting) + @type = args[:type] if args.key?(:type) + end + end + + # Campaign ad blocking settings. + class AdBlockingConfiguration + include Google::Apis::Core::Hashable + + # Click-through URL used by brand-neutral ads. This is a required field when + # overrideClickThroughUrl is set to true. + # Corresponds to the JSON property `clickThroughUrl` + # @return [String] + attr_accessor :click_through_url + + # ID of a creative bundle to use for this campaign. If set, brand-neutral ads + # will select creatives from this bundle. Otherwise, a default transparent pixel + # will be used. + # Corresponds to the JSON property `creativeBundleId` + # @return [Fixnum] + attr_accessor :creative_bundle_id + + # Whether this campaign has enabled ad blocking. When true, ad blocking is + # enabled for placements in the campaign, but this may be overridden by site and + # placement settings. When false, ad blocking is disabled for all placements + # under the campaign, regardless of site and placement settings. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + # Whether the brand-neutral ad's click-through URL comes from the campaign's + # creative bundle or the override URL. Must be set to true if ad blocking is + # enabled and no creative bundle is configured. + # Corresponds to the JSON property `overrideClickThroughUrl` + # @return [Boolean] + attr_accessor :override_click_through_url + alias_method :override_click_through_url?, :override_click_through_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @click_through_url = args[:click_through_url] if args.key?(:click_through_url) + @creative_bundle_id = args[:creative_bundle_id] if args.key?(:creative_bundle_id) + @enabled = args[:enabled] if args.key?(:enabled) + @override_click_through_url = args[:override_click_through_url] if args.key?(:override_click_through_url) + end + end + + # Ad Slot + class AdSlot + include Google::Apis::Core::Hashable + + # Comment for this ad slot. + # Corresponds to the JSON property `comment` + # @return [String] + attr_accessor :comment + + # Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering + # either on desktop, mobile devices or in mobile apps for regular or + # interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in + # mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads + # developed with the VAST standard. + # Corresponds to the JSON property `compatibility` + # @return [String] + attr_accessor :compatibility + + # Height of this ad slot. + # Corresponds to the JSON property `height` + # @return [Fixnum] + attr_accessor :height + + # ID of the placement from an external platform that is linked to this ad slot. + # Corresponds to the JSON property `linkedPlacementId` + # @return [Fixnum] + attr_accessor :linked_placement_id + + # Name of this ad slot. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Payment source type of this ad slot. + # Corresponds to the JSON property `paymentSourceType` + # @return [String] + attr_accessor :payment_source_type + + # Primary ad slot of a roadblock inventory item. + # Corresponds to the JSON property `primary` + # @return [Boolean] + attr_accessor :primary + alias_method :primary?, :primary + + # Width of this ad slot. + # Corresponds to the JSON property `width` + # @return [Fixnum] + attr_accessor :width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @comment = args[:comment] if args.key?(:comment) + @compatibility = args[:compatibility] if args.key?(:compatibility) + @height = args[:height] if args.key?(:height) + @linked_placement_id = args[:linked_placement_id] if args.key?(:linked_placement_id) + @name = args[:name] if args.key?(:name) + @payment_source_type = args[:payment_source_type] if args.key?(:payment_source_type) + @primary = args[:primary] if args.key?(:primary) + @width = args[:width] if args.key?(:width) + end + end + + # Ad List Response + class AdsListResponse + include Google::Apis::Core::Hashable + + # Ad collection. + # Corresponds to the JSON property `ads` + # @return [Array] + attr_accessor :ads + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#adsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ads = args[:ads] if args.key?(:ads) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Contains properties of a DCM advertiser. + class Advertiser + include Google::Apis::Core::Hashable + + # Account ID of this advertiser.This is a read-only field that can be left blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # ID of the advertiser group this advertiser belongs to. You can group + # advertisers for reporting purposes, allowing you to see aggregated information + # for all advertisers in each group. + # Corresponds to the JSON property `advertiserGroupId` + # @return [Fixnum] + attr_accessor :advertiser_group_id + + # Suffix added to click-through URL of ad creative associations under this + # advertiser. Must be less than 129 characters long. + # Corresponds to the JSON property `clickThroughUrlSuffix` + # @return [String] + attr_accessor :click_through_url_suffix + + # ID of the click-through event tag to apply by default to the landing pages of + # this advertiser's campaigns. + # Corresponds to the JSON property `defaultClickThroughEventTagId` + # @return [Fixnum] + attr_accessor :default_click_through_event_tag_id + + # Default email address used in sender field for tag emails. + # Corresponds to the JSON property `defaultEmail` + # @return [String] + attr_accessor :default_email + + # Floodlight configuration ID of this advertiser. The floodlight configuration + # ID will be created automatically, so on insert this field should be left blank. + # This field can be set to another advertiser's floodlight configuration ID in + # order to share that advertiser's floodlight configuration with this advertiser, + # so long as: + # - This advertiser's original floodlight configuration is not already + # associated with floodlight activities or floodlight activity groups. + # - This advertiser's original floodlight configuration is not already shared + # with another advertiser. + # Corresponds to the JSON property `floodlightConfigurationId` + # @return [Fixnum] + attr_accessor :floodlight_configuration_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :floodlight_configuration_id_dimension_value + + # ID of this advertiser. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :id_dimension_value + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#advertiser". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this advertiser. This is a required field and must be less than 256 + # characters long and unique among advertisers of the same account. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Original floodlight configuration before any sharing occurred. Set the + # floodlightConfigurationId of this advertiser to + # originalFloodlightConfigurationId to unshare the advertiser's current + # floodlight configuration. You cannot unshare an advertiser's floodlight + # configuration if the shared configuration has activities associated with any + # campaign or placement. + # Corresponds to the JSON property `originalFloodlightConfigurationId` + # @return [Fixnum] + attr_accessor :original_floodlight_configuration_id + + # Status of this advertiser. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # Subaccount ID of this advertiser.This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Suspension status of this advertiser. + # Corresponds to the JSON property `suspended` + # @return [Boolean] + attr_accessor :suspended + alias_method :suspended?, :suspended + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_group_id = args[:advertiser_group_id] if args.key?(:advertiser_group_id) + @click_through_url_suffix = args[:click_through_url_suffix] if args.key?(:click_through_url_suffix) + @default_click_through_event_tag_id = args[:default_click_through_event_tag_id] if args.key?(:default_click_through_event_tag_id) + @default_email = args[:default_email] if args.key?(:default_email) + @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) + @floodlight_configuration_id_dimension_value = args[:floodlight_configuration_id_dimension_value] if args.key?(:floodlight_configuration_id_dimension_value) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @original_floodlight_configuration_id = args[:original_floodlight_configuration_id] if args.key?(:original_floodlight_configuration_id) + @status = args[:status] if args.key?(:status) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @suspended = args[:suspended] if args.key?(:suspended) + end + end + + # Groups advertisers together so that reports can be generated for the entire + # group at once. + class AdvertiserGroup + include Google::Apis::Core::Hashable + + # Account ID of this advertiser group. This is a read-only field that can be + # left blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # ID of this advertiser group. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#advertiserGroup". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this advertiser group. This is a required field and must be less than + # 256 characters long and unique among advertiser groups of the same account. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Advertiser Group List Response + class AdvertiserGroupsListResponse + include Google::Apis::Core::Hashable + + # Advertiser group collection. + # Corresponds to the JSON property `advertiserGroups` + # @return [Array] + attr_accessor :advertiser_groups + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#advertiserGroupsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_groups = args[:advertiser_groups] if args.key?(:advertiser_groups) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Landing Page List Response + class AdvertiserLandingPagesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#advertiserLandingPagesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Landing page collection + # Corresponds to the JSON property `landingPages` + # @return [Array] + attr_accessor :landing_pages + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @landing_pages = args[:landing_pages] if args.key?(:landing_pages) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Advertiser List Response + class AdvertisersListResponse + include Google::Apis::Core::Hashable + + # Advertiser collection. + # Corresponds to the JSON property `advertisers` + # @return [Array] + attr_accessor :advertisers + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#advertisersListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertisers = args[:advertisers] if args.key?(:advertisers) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Audience Segment. + class AudienceSegment + include Google::Apis::Core::Hashable + + # Weight allocated to this segment. The weight assigned will be understood in + # proportion to the weights assigned to other segments in the same segment group. + # Acceptable values are 1 to 1000, inclusive. + # Corresponds to the JSON property `allocation` + # @return [Fixnum] + attr_accessor :allocation + + # ID of this audience segment. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Name of this audience segment. This is a required field and must be less than + # 65 characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allocation = args[:allocation] if args.key?(:allocation) + @id = args[:id] if args.key?(:id) + @name = args[:name] if args.key?(:name) + end + end + + # Audience Segment Group. + class AudienceSegmentGroup + include Google::Apis::Core::Hashable + + # Audience segments assigned to this group. The number of segments must be + # between 2 and 100. + # Corresponds to the JSON property `audienceSegments` + # @return [Array] + attr_accessor :audience_segments + + # ID of this audience segment group. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Name of this audience segment group. This is a required field and must be less + # than 65 characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audience_segments = args[:audience_segments] if args.key?(:audience_segments) + @id = args[:id] if args.key?(:id) + @name = args[:name] if args.key?(:name) + end + end + + # Contains information about a browser that can be targeted by ads. + class Browser + include Google::Apis::Core::Hashable + + # ID referring to this grouping of browser and version numbers. This is the ID + # used for targeting. + # Corresponds to the JSON property `browserVersionId` + # @return [Fixnum] + attr_accessor :browser_version_id + + # DART ID of this browser. This is the ID used when generating reports. + # Corresponds to the JSON property `dartId` + # @return [Fixnum] + attr_accessor :dart_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#browser". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Major version number (leftmost number) of this browser. For example, for + # Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) may be + # used to target any version number, and a question mark (?) may be used to + # target cases where the version number cannot be identified. For example, + # Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. Chrome 3.* + # targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases where the ad + # server knows the browser is Firefox but can't tell which version it is. + # Corresponds to the JSON property `majorVersion` + # @return [String] + attr_accessor :major_version + + # Minor version number (number after first dot on left) of this browser. For + # example, for Chrome 5.0.375.86 beta, this field should be set to 0. An + # asterisk (*) may be used to target any version number, and a question mark (?) + # may be used to target cases where the version number cannot be identified. For + # example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so on. + # Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets cases + # where the ad server knows the browser is Firefox but can't tell which version + # it is. + # Corresponds to the JSON property `minorVersion` + # @return [String] + attr_accessor :minor_version + + # Name of this browser. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @browser_version_id = args[:browser_version_id] if args.key?(:browser_version_id) + @dart_id = args[:dart_id] if args.key?(:dart_id) + @kind = args[:kind] if args.key?(:kind) + @major_version = args[:major_version] if args.key?(:major_version) + @minor_version = args[:minor_version] if args.key?(:minor_version) + @name = args[:name] if args.key?(:name) + end + end + + # Browser List Response + class BrowsersListResponse + include Google::Apis::Core::Hashable + + # Browser collection. + # Corresponds to the JSON property `browsers` + # @return [Array] + attr_accessor :browsers + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#browsersListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @browsers = args[:browsers] if args.key?(:browsers) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Contains properties of a DCM campaign. + class Campaign + include Google::Apis::Core::Hashable + + # Account ID of this campaign. This is a read-only field that can be left blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Campaign ad blocking settings. + # Corresponds to the JSON property `adBlockingConfiguration` + # @return [Google::Apis::DfareportingV3_0::AdBlockingConfiguration] + attr_accessor :ad_blocking_configuration + + # Additional creative optimization configurations for the campaign. + # Corresponds to the JSON property `additionalCreativeOptimizationConfigurations` + # @return [Array] + attr_accessor :additional_creative_optimization_configurations + + # Advertiser group ID of the associated advertiser. + # Corresponds to the JSON property `advertiserGroupId` + # @return [Fixnum] + attr_accessor :advertiser_group_id + + # Advertiser ID of this campaign. This is a required field. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Whether this campaign has been archived. + # Corresponds to the JSON property `archived` + # @return [Boolean] + attr_accessor :archived + alias_method :archived?, :archived + + # Audience segment groups assigned to this campaign. Cannot have more than 300 + # segment groups. + # Corresponds to the JSON property `audienceSegmentGroups` + # @return [Array] + attr_accessor :audience_segment_groups + + # Billing invoice code included in the DCM client billing invoices associated + # with the campaign. + # Corresponds to the JSON property `billingInvoiceCode` + # @return [String] + attr_accessor :billing_invoice_code + + # Click Through URL Suffix settings. + # Corresponds to the JSON property `clickThroughUrlSuffixProperties` + # @return [Google::Apis::DfareportingV3_0::ClickThroughUrlSuffixProperties] + attr_accessor :click_through_url_suffix_properties + + # Arbitrary comments about this campaign. Must be less than 256 characters long. + # Corresponds to the JSON property `comment` + # @return [String] + attr_accessor :comment + + # Modification timestamp. + # Corresponds to the JSON property `createInfo` + # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] + attr_accessor :create_info + + # List of creative group IDs that are assigned to the campaign. + # Corresponds to the JSON property `creativeGroupIds` + # @return [Array] + attr_accessor :creative_group_ids + + # Creative optimization settings. + # Corresponds to the JSON property `creativeOptimizationConfiguration` + # @return [Google::Apis::DfareportingV3_0::CreativeOptimizationConfiguration] + attr_accessor :creative_optimization_configuration + + # Properties of inheriting and overriding the default click-through event tag. A + # campaign may override the event tag defined at the advertiser level, and an ad + # may also override the campaign's setting further. + # Corresponds to the JSON property `defaultClickThroughEventTagProperties` + # @return [Google::Apis::DfareportingV3_0::DefaultClickThroughEventTagProperties] + attr_accessor :default_click_through_event_tag_properties + + # The default landing page ID for this campaign. + # Corresponds to the JSON property `defaultLandingPageId` + # @return [Fixnum] + attr_accessor :default_landing_page_id + + # Date on which the campaign will stop running. On insert, the end date must be + # today or a future date. The end date must be later than or be the same as the + # start date. If, for example, you set 6/25/2015 as both the start and end dates, + # the effective campaign run date is just that day only, 6/25/2015. The hours, + # minutes, and seconds of the end date should not be set, as doing so will + # result in an error. This is a required field. + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # Overrides that can be used to activate or deactivate advertiser event tags. + # Corresponds to the JSON property `eventTagOverrides` + # @return [Array] + attr_accessor :event_tag_overrides + + # External ID for this campaign. + # Corresponds to the JSON property `externalId` + # @return [String] + attr_accessor :external_id + + # ID of this campaign. This is a read-only auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :id_dimension_value + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#campaign". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] + attr_accessor :last_modified_info + + # Lookback configuration settings. + # Corresponds to the JSON property `lookbackConfiguration` + # @return [Google::Apis::DfareportingV3_0::LookbackConfiguration] + attr_accessor :lookback_configuration + + # Name of this campaign. This is a required field and must be less than 256 + # characters long and unique among campaigns of the same advertiser. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Whether Nielsen reports are enabled for this campaign. + # Corresponds to the JSON property `nielsenOcrEnabled` + # @return [Boolean] + attr_accessor :nielsen_ocr_enabled + alias_method :nielsen_ocr_enabled?, :nielsen_ocr_enabled + + # Date on which the campaign starts running. The start date can be any date. The + # hours, minutes, and seconds of the start date should not be set, as doing so + # will result in an error. This is a required field. + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + # Subaccount ID of this campaign. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Campaign trafficker contact emails. + # Corresponds to the JSON property `traffickerEmails` + # @return [Array] + attr_accessor :trafficker_emails + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @ad_blocking_configuration = args[:ad_blocking_configuration] if args.key?(:ad_blocking_configuration) + @additional_creative_optimization_configurations = args[:additional_creative_optimization_configurations] if args.key?(:additional_creative_optimization_configurations) + @advertiser_group_id = args[:advertiser_group_id] if args.key?(:advertiser_group_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @archived = args[:archived] if args.key?(:archived) + @audience_segment_groups = args[:audience_segment_groups] if args.key?(:audience_segment_groups) + @billing_invoice_code = args[:billing_invoice_code] if args.key?(:billing_invoice_code) + @click_through_url_suffix_properties = args[:click_through_url_suffix_properties] if args.key?(:click_through_url_suffix_properties) + @comment = args[:comment] if args.key?(:comment) + @create_info = args[:create_info] if args.key?(:create_info) + @creative_group_ids = args[:creative_group_ids] if args.key?(:creative_group_ids) + @creative_optimization_configuration = args[:creative_optimization_configuration] if args.key?(:creative_optimization_configuration) + @default_click_through_event_tag_properties = args[:default_click_through_event_tag_properties] if args.key?(:default_click_through_event_tag_properties) + @default_landing_page_id = args[:default_landing_page_id] if args.key?(:default_landing_page_id) + @end_date = args[:end_date] if args.key?(:end_date) + @event_tag_overrides = args[:event_tag_overrides] if args.key?(:event_tag_overrides) + @external_id = args[:external_id] if args.key?(:external_id) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @kind = args[:kind] if args.key?(:kind) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) + @name = args[:name] if args.key?(:name) + @nielsen_ocr_enabled = args[:nielsen_ocr_enabled] if args.key?(:nielsen_ocr_enabled) + @start_date = args[:start_date] if args.key?(:start_date) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @trafficker_emails = args[:trafficker_emails] if args.key?(:trafficker_emails) + end + end + + # Identifies a creative which has been associated with a given campaign. + class CampaignCreativeAssociation + include Google::Apis::Core::Hashable + + # ID of the creative associated with the campaign. This is a required field. + # Corresponds to the JSON property `creativeId` + # @return [Fixnum] + attr_accessor :creative_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#campaignCreativeAssociation". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_id = args[:creative_id] if args.key?(:creative_id) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Campaign Creative Association List Response + class CampaignCreativeAssociationsListResponse + include Google::Apis::Core::Hashable + + # Campaign creative association collection + # Corresponds to the JSON property `campaignCreativeAssociations` + # @return [Array] + attr_accessor :campaign_creative_associations + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#campaignCreativeAssociationsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @campaign_creative_associations = args[:campaign_creative_associations] if args.key?(:campaign_creative_associations) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Campaign List Response + class CampaignsListResponse + include Google::Apis::Core::Hashable + + # Campaign collection. + # Corresponds to the JSON property `campaigns` + # @return [Array] + attr_accessor :campaigns + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#campaignsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @campaigns = args[:campaigns] if args.key?(:campaigns) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Describes a change that a user has made to a resource. + class ChangeLog + include Google::Apis::Core::Hashable + + # Account ID of the modified object. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Action which caused the change. + # Corresponds to the JSON property `action` + # @return [String] + attr_accessor :action + + # Time when the object was modified. + # Corresponds to the JSON property `changeTime` + # @return [DateTime] + attr_accessor :change_time + + # Field name of the object which changed. + # Corresponds to the JSON property `fieldName` + # @return [String] + attr_accessor :field_name + + # ID of this change log. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#changeLog". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # New value of the object field. + # Corresponds to the JSON property `newValue` + # @return [String] + attr_accessor :new_value + + # ID of the object of this change log. The object could be a campaign, placement, + # ad, or other type. + # Corresponds to the JSON property `objectId` + # @return [Fixnum] + attr_accessor :object_id_prop + + # Object type of the change log. + # Corresponds to the JSON property `objectType` + # @return [String] + attr_accessor :object_type + + # Old value of the object field. + # Corresponds to the JSON property `oldValue` + # @return [String] + attr_accessor :old_value + + # Subaccount ID of the modified object. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Transaction ID of this change log. When a single API call results in many + # changes, each change will have a separate ID in the change log but will share + # the same transactionId. + # Corresponds to the JSON property `transactionId` + # @return [Fixnum] + attr_accessor :transaction_id + + # ID of the user who modified the object. + # Corresponds to the JSON property `userProfileId` + # @return [Fixnum] + attr_accessor :user_profile_id + + # User profile name of the user who modified the object. + # Corresponds to the JSON property `userProfileName` + # @return [String] + attr_accessor :user_profile_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @action = args[:action] if args.key?(:action) + @change_time = args[:change_time] if args.key?(:change_time) + @field_name = args[:field_name] if args.key?(:field_name) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @new_value = args[:new_value] if args.key?(:new_value) + @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) + @object_type = args[:object_type] if args.key?(:object_type) + @old_value = args[:old_value] if args.key?(:old_value) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @transaction_id = args[:transaction_id] if args.key?(:transaction_id) + @user_profile_id = args[:user_profile_id] if args.key?(:user_profile_id) + @user_profile_name = args[:user_profile_name] if args.key?(:user_profile_name) + end + end + + # Change Log List Response + class ChangeLogsListResponse + include Google::Apis::Core::Hashable + + # Change log collection. + # Corresponds to the JSON property `changeLogs` + # @return [Array] + attr_accessor :change_logs + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#changeLogsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @change_logs = args[:change_logs] if args.key?(:change_logs) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # City List Response + class CitiesListResponse + include Google::Apis::Core::Hashable + + # City collection. + # Corresponds to the JSON property `cities` + # @return [Array] + attr_accessor :cities + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#citiesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cities = args[:cities] if args.key?(:cities) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Contains information about a city that can be targeted by ads. + class City + include Google::Apis::Core::Hashable + + # Country code of the country to which this city belongs. + # Corresponds to the JSON property `countryCode` + # @return [String] + attr_accessor :country_code + + # DART ID of the country to which this city belongs. + # Corresponds to the JSON property `countryDartId` + # @return [Fixnum] + attr_accessor :country_dart_id + + # DART ID of this city. This is the ID used for targeting and generating reports. + # Corresponds to the JSON property `dartId` + # @return [Fixnum] + attr_accessor :dart_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#city". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metro region code of the metro region (DMA) to which this city belongs. + # Corresponds to the JSON property `metroCode` + # @return [String] + attr_accessor :metro_code + + # ID of the metro region (DMA) to which this city belongs. + # Corresponds to the JSON property `metroDmaId` + # @return [Fixnum] + attr_accessor :metro_dma_id + + # Name of this city. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Region code of the region to which this city belongs. + # Corresponds to the JSON property `regionCode` + # @return [String] + attr_accessor :region_code + + # DART ID of the region to which this city belongs. + # Corresponds to the JSON property `regionDartId` + # @return [Fixnum] + attr_accessor :region_dart_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @country_code = args[:country_code] if args.key?(:country_code) + @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) + @dart_id = args[:dart_id] if args.key?(:dart_id) + @kind = args[:kind] if args.key?(:kind) + @metro_code = args[:metro_code] if args.key?(:metro_code) + @metro_dma_id = args[:metro_dma_id] if args.key?(:metro_dma_id) + @name = args[:name] if args.key?(:name) + @region_code = args[:region_code] if args.key?(:region_code) + @region_dart_id = args[:region_dart_id] if args.key?(:region_dart_id) + end + end + + # Creative Click Tag. + class ClickTag + include Google::Apis::Core::Hashable + + # Click-through URL + # Corresponds to the JSON property `clickThroughUrl` + # @return [Google::Apis::DfareportingV3_0::CreativeClickThroughUrl] + attr_accessor :click_through_url + + # Advertiser event name associated with the click tag. This field is used by + # DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when + # the primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `eventName` + # @return [String] + attr_accessor :event_name + + # Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative + # assets, this field must match the value of the creative asset's + # creativeAssetId.name field. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @click_through_url = args[:click_through_url] if args.key?(:click_through_url) + @event_name = args[:event_name] if args.key?(:event_name) + @name = args[:name] if args.key?(:name) + end + end + + # Click-through URL + class ClickThroughUrl + include Google::Apis::Core::Hashable + + # Read-only convenience field representing the actual URL that will be used for + # this click-through. The URL is computed as follows: + # - If defaultLandingPage is enabled then the campaign's default landing page + # URL is assigned to this field. + # - If defaultLandingPage is not enabled and a landingPageId is specified then + # that landing page's URL is assigned to this field. + # - If neither of the above cases apply, then the customClickThroughUrl is + # assigned to this field. + # Corresponds to the JSON property `computedClickThroughUrl` + # @return [String] + attr_accessor :computed_click_through_url + + # Custom click-through URL. Applicable if the defaultLandingPage field is set to + # false and the landingPageId field is left unset. + # Corresponds to the JSON property `customClickThroughUrl` + # @return [String] + attr_accessor :custom_click_through_url + + # Whether the campaign default landing page is used. + # Corresponds to the JSON property `defaultLandingPage` + # @return [Boolean] + attr_accessor :default_landing_page + alias_method :default_landing_page?, :default_landing_page + + # ID of the landing page for the click-through URL. Applicable if the + # defaultLandingPage field is set to false. + # Corresponds to the JSON property `landingPageId` + # @return [Fixnum] + attr_accessor :landing_page_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @computed_click_through_url = args[:computed_click_through_url] if args.key?(:computed_click_through_url) + @custom_click_through_url = args[:custom_click_through_url] if args.key?(:custom_click_through_url) + @default_landing_page = args[:default_landing_page] if args.key?(:default_landing_page) + @landing_page_id = args[:landing_page_id] if args.key?(:landing_page_id) + end + end + + # Click Through URL Suffix settings. + class ClickThroughUrlSuffixProperties + include Google::Apis::Core::Hashable + + # Click-through URL suffix to apply to all ads in this entity's scope. Must be + # less than 128 characters long. + # Corresponds to the JSON property `clickThroughUrlSuffix` + # @return [String] + attr_accessor :click_through_url_suffix + + # Whether this entity should override the inherited click-through URL suffix + # with its own defined value. + # Corresponds to the JSON property `overrideInheritedSuffix` + # @return [Boolean] + attr_accessor :override_inherited_suffix + alias_method :override_inherited_suffix?, :override_inherited_suffix + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @click_through_url_suffix = args[:click_through_url_suffix] if args.key?(:click_through_url_suffix) + @override_inherited_suffix = args[:override_inherited_suffix] if args.key?(:override_inherited_suffix) + end + end + + # Companion Click-through override. + class CompanionClickThroughOverride + include Google::Apis::Core::Hashable + + # Click-through URL + # Corresponds to the JSON property `clickThroughUrl` + # @return [Google::Apis::DfareportingV3_0::ClickThroughUrl] + attr_accessor :click_through_url + + # ID of the creative for this companion click-through override. + # Corresponds to the JSON property `creativeId` + # @return [Fixnum] + attr_accessor :creative_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @click_through_url = args[:click_through_url] if args.key?(:click_through_url) + @creative_id = args[:creative_id] if args.key?(:creative_id) + end + end + + # Companion Settings + class CompanionSetting + include Google::Apis::Core::Hashable + + # Whether companions are disabled for this placement. + # Corresponds to the JSON property `companionsDisabled` + # @return [Boolean] + attr_accessor :companions_disabled + alias_method :companions_disabled?, :companions_disabled + + # Whitelist of companion sizes to be served to this placement. Set this list to + # null or empty to serve all companion sizes. + # Corresponds to the JSON property `enabledSizes` + # @return [Array] + attr_accessor :enabled_sizes + + # Whether to serve only static images as companions. + # Corresponds to the JSON property `imageOnly` + # @return [Boolean] + attr_accessor :image_only + alias_method :image_only?, :image_only + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#companionSetting". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @companions_disabled = args[:companions_disabled] if args.key?(:companions_disabled) + @enabled_sizes = args[:enabled_sizes] if args.key?(:enabled_sizes) + @image_only = args[:image_only] if args.key?(:image_only) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Represents a response to the queryCompatibleFields method. + class CompatibleFields + include Google::Apis::Core::Hashable + + # Represents fields that are compatible to be selected for a report of type " + # CROSS_DIMENSION_REACH". + # Corresponds to the JSON property `crossDimensionReachReportCompatibleFields` + # @return [Google::Apis::DfareportingV3_0::CrossDimensionReachReportCompatibleFields] + attr_accessor :cross_dimension_reach_report_compatible_fields + + # Represents fields that are compatible to be selected for a report of type " + # FlOODLIGHT". + # Corresponds to the JSON property `floodlightReportCompatibleFields` + # @return [Google::Apis::DfareportingV3_0::FloodlightReportCompatibleFields] + attr_accessor :floodlight_report_compatible_fields + + # The kind of resource this is, in this case dfareporting#compatibleFields. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Represents fields that are compatible to be selected for a report of type " + # PATH_TO_CONVERSION". + # Corresponds to the JSON property `pathToConversionReportCompatibleFields` + # @return [Google::Apis::DfareportingV3_0::PathToConversionReportCompatibleFields] + attr_accessor :path_to_conversion_report_compatible_fields + + # Represents fields that are compatible to be selected for a report of type " + # REACH". + # Corresponds to the JSON property `reachReportCompatibleFields` + # @return [Google::Apis::DfareportingV3_0::ReachReportCompatibleFields] + attr_accessor :reach_report_compatible_fields + + # Represents fields that are compatible to be selected for a report of type " + # STANDARD". + # Corresponds to the JSON property `reportCompatibleFields` + # @return [Google::Apis::DfareportingV3_0::ReportCompatibleFields] + attr_accessor :report_compatible_fields + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cross_dimension_reach_report_compatible_fields = args[:cross_dimension_reach_report_compatible_fields] if args.key?(:cross_dimension_reach_report_compatible_fields) + @floodlight_report_compatible_fields = args[:floodlight_report_compatible_fields] if args.key?(:floodlight_report_compatible_fields) + @kind = args[:kind] if args.key?(:kind) + @path_to_conversion_report_compatible_fields = args[:path_to_conversion_report_compatible_fields] if args.key?(:path_to_conversion_report_compatible_fields) + @reach_report_compatible_fields = args[:reach_report_compatible_fields] if args.key?(:reach_report_compatible_fields) + @report_compatible_fields = args[:report_compatible_fields] if args.key?(:report_compatible_fields) + end + end + + # Contains information about an internet connection type that can be targeted by + # ads. Clients can use the connection type to target mobile vs. broadband users. + class ConnectionType + include Google::Apis::Core::Hashable + + # ID of this connection type. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#connectionType". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this connection type. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Connection Type List Response + class ConnectionTypesListResponse + include Google::Apis::Core::Hashable + + # Collection of connection types such as broadband and mobile. + # Corresponds to the JSON property `connectionTypes` + # @return [Array] + attr_accessor :connection_types + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#connectionTypesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @connection_types = args[:connection_types] if args.key?(:connection_types) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Content Category List Response + class ContentCategoriesListResponse + include Google::Apis::Core::Hashable + + # Content category collection. + # Corresponds to the JSON property `contentCategories` + # @return [Array] + attr_accessor :content_categories + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#contentCategoriesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_categories = args[:content_categories] if args.key?(:content_categories) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Organizes placements according to the contents of their associated webpages. + class ContentCategory + include Google::Apis::Core::Hashable + + # Account ID of this content category. This is a read-only field that can be + # left blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # ID of this content category. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#contentCategory". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this content category. This is a required field and must be less than + # 256 characters long and unique among content categories of the same account. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # A Conversion represents when a user successfully performs a desired action + # after seeing an ad. + class Conversion + include Google::Apis::Core::Hashable + + # Whether the conversion was directed toward children. + # Corresponds to the JSON property `childDirectedTreatment` + # @return [Boolean] + attr_accessor :child_directed_treatment + alias_method :child_directed_treatment?, :child_directed_treatment + + # Custom floodlight variables. + # Corresponds to the JSON property `customVariables` + # @return [Array] + attr_accessor :custom_variables + + # The alphanumeric encrypted user ID. When set, encryptionInfo should also be + # specified. This field is mutually exclusive with encryptedUserIdCandidates[], + # mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or + # mobileDeviceId or gclid is a required field. + # Corresponds to the JSON property `encryptedUserId` + # @return [String] + attr_accessor :encrypted_user_id + + # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior + # to the conversion timestamp will be used in the inserted conversion. If no + # such user ID is found then the conversion will be rejected with + # NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo should also be specified. + # This field may only be used when calling batchinsert; it is not supported by + # batchupdate. This field is mutually exclusive with encryptedUserId, + # mobileDeviceId and gclid. This or encryptedUserId or mobileDeviceId or gclid + # is a required field. + # Corresponds to the JSON property `encryptedUserIdCandidates` + # @return [Array] + attr_accessor :encrypted_user_id_candidates + + # Floodlight Activity ID of this conversion. This is a required field. + # Corresponds to the JSON property `floodlightActivityId` + # @return [Fixnum] + attr_accessor :floodlight_activity_id + + # Floodlight Configuration ID of this conversion. This is a required field. + # Corresponds to the JSON property `floodlightConfigurationId` + # @return [Fixnum] + attr_accessor :floodlight_configuration_id + + # The Google click ID. This field is mutually exclusive with encryptedUserId, + # encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserId or + # encryptedUserIdCandidates[] or mobileDeviceId is a required field. + # Corresponds to the JSON property `gclid` + # @return [String] + attr_accessor :gclid + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#conversion". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be + # used for reporting but not targeting. This will prevent remarketing. + # Corresponds to the JSON property `limitAdTracking` + # @return [Boolean] + attr_accessor :limit_ad_tracking + alias_method :limit_ad_tracking?, :limit_ad_tracking + + # The mobile device ID. This field is mutually exclusive with encryptedUserId, + # encryptedUserIdCandidates[] and gclid. This or encryptedUserId or + # encryptedUserIdCandidates[] or gclid is a required field. + # Corresponds to the JSON property `mobileDeviceId` + # @return [String] + attr_accessor :mobile_device_id + + # The ordinal of the conversion. Use this field to control how conversions of + # the same user and day are de-duplicated. This is a required field. + # Corresponds to the JSON property `ordinal` + # @return [String] + attr_accessor :ordinal + + # The quantity of the conversion. + # Corresponds to the JSON property `quantity` + # @return [Fixnum] + attr_accessor :quantity + + # The timestamp of conversion, in Unix epoch micros. This is a required field. + # Corresponds to the JSON property `timestampMicros` + # @return [Fixnum] + attr_accessor :timestamp_micros + + # The value of the conversion. + # Corresponds to the JSON property `value` + # @return [Float] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @child_directed_treatment = args[:child_directed_treatment] if args.key?(:child_directed_treatment) + @custom_variables = args[:custom_variables] if args.key?(:custom_variables) + @encrypted_user_id = args[:encrypted_user_id] if args.key?(:encrypted_user_id) + @encrypted_user_id_candidates = args[:encrypted_user_id_candidates] if args.key?(:encrypted_user_id_candidates) + @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id) + @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) + @gclid = args[:gclid] if args.key?(:gclid) + @kind = args[:kind] if args.key?(:kind) + @limit_ad_tracking = args[:limit_ad_tracking] if args.key?(:limit_ad_tracking) + @mobile_device_id = args[:mobile_device_id] if args.key?(:mobile_device_id) + @ordinal = args[:ordinal] if args.key?(:ordinal) + @quantity = args[:quantity] if args.key?(:quantity) + @timestamp_micros = args[:timestamp_micros] if args.key?(:timestamp_micros) + @value = args[:value] if args.key?(:value) + end + end + + # The error code and description for a conversion that failed to insert or + # update. + class ConversionError + include Google::Apis::Core::Hashable + + # The error code. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#conversionError". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # A description of the error. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @kind = args[:kind] if args.key?(:kind) + @message = args[:message] if args.key?(:message) + end + end + + # The original conversion that was inserted or updated and whether there were + # any errors. + class ConversionStatus + include Google::Apis::Core::Hashable + + # A Conversion represents when a user successfully performs a desired action + # after seeing an ad. + # Corresponds to the JSON property `conversion` + # @return [Google::Apis::DfareportingV3_0::Conversion] + attr_accessor :conversion + + # A list of errors related to this conversion. + # Corresponds to the JSON property `errors` + # @return [Array] + attr_accessor :errors + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#conversionStatus". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @conversion = args[:conversion] if args.key?(:conversion) + @errors = args[:errors] if args.key?(:errors) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Insert Conversions Request. + class ConversionsBatchInsertRequest + include Google::Apis::Core::Hashable + + # The set of conversions to insert. + # Corresponds to the JSON property `conversions` + # @return [Array] + attr_accessor :conversions + + # A description of how user IDs are encrypted. + # Corresponds to the JSON property `encryptionInfo` + # @return [Google::Apis::DfareportingV3_0::EncryptionInfo] + attr_accessor :encryption_info + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#conversionsBatchInsertRequest". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @conversions = args[:conversions] if args.key?(:conversions) + @encryption_info = args[:encryption_info] if args.key?(:encryption_info) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Insert Conversions Response. + class ConversionsBatchInsertResponse + include Google::Apis::Core::Hashable + + # Indicates that some or all conversions failed to insert. + # Corresponds to the JSON property `hasFailures` + # @return [Boolean] + attr_accessor :has_failures + alias_method :has_failures?, :has_failures + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#conversionsBatchInsertResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The insert status of each conversion. Statuses are returned in the same order + # that conversions are inserted. + # Corresponds to the JSON property `status` + # @return [Array] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @has_failures = args[:has_failures] if args.key?(:has_failures) + @kind = args[:kind] if args.key?(:kind) + @status = args[:status] if args.key?(:status) + end + end + + # Update Conversions Request. + class ConversionsBatchUpdateRequest + include Google::Apis::Core::Hashable + + # The set of conversions to update. + # Corresponds to the JSON property `conversions` + # @return [Array] + attr_accessor :conversions + + # A description of how user IDs are encrypted. + # Corresponds to the JSON property `encryptionInfo` + # @return [Google::Apis::DfareportingV3_0::EncryptionInfo] + attr_accessor :encryption_info + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#conversionsBatchUpdateRequest". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @conversions = args[:conversions] if args.key?(:conversions) + @encryption_info = args[:encryption_info] if args.key?(:encryption_info) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Update Conversions Response. + class ConversionsBatchUpdateResponse + include Google::Apis::Core::Hashable + + # Indicates that some or all conversions failed to update. + # Corresponds to the JSON property `hasFailures` + # @return [Boolean] + attr_accessor :has_failures + alias_method :has_failures?, :has_failures + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#conversionsBatchUpdateResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The update status of each conversion. Statuses are returned in the same order + # that conversions are updated. + # Corresponds to the JSON property `status` + # @return [Array] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @has_failures = args[:has_failures] if args.key?(:has_failures) + @kind = args[:kind] if args.key?(:kind) + @status = args[:status] if args.key?(:status) + end + end + + # Country List Response + class CountriesListResponse + include Google::Apis::Core::Hashable + + # Country collection. + # Corresponds to the JSON property `countries` + # @return [Array] + attr_accessor :countries + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#countriesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @countries = args[:countries] if args.key?(:countries) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Contains information about a country that can be targeted by ads. + class Country + include Google::Apis::Core::Hashable + + # Country code. + # Corresponds to the JSON property `countryCode` + # @return [String] + attr_accessor :country_code + + # DART ID of this country. This is the ID used for targeting and generating + # reports. + # Corresponds to the JSON property `dartId` + # @return [Fixnum] + attr_accessor :dart_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#country". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this country. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Whether ad serving supports secure servers in this country. + # Corresponds to the JSON property `sslEnabled` + # @return [Boolean] + attr_accessor :ssl_enabled + alias_method :ssl_enabled?, :ssl_enabled + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @country_code = args[:country_code] if args.key?(:country_code) + @dart_id = args[:dart_id] if args.key?(:dart_id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @ssl_enabled = args[:ssl_enabled] if args.key?(:ssl_enabled) + end + end + + # Contains properties of a Creative. + class Creative + include Google::Apis::Core::Hashable + + # Account ID of this creative. This field, if left unset, will be auto-generated + # for both insert and update operations. Applicable to all creative types. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Whether the creative is active. Applicable to all creative types. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Ad parameters user for VPAID creative. This is a read-only field. Applicable + # to the following creative types: all VPAID. + # Corresponds to the JSON property `adParameters` + # @return [String] + attr_accessor :ad_parameters + + # Keywords for a Rich Media creative. Keywords let you customize the creative + # settings of a Rich Media ad running on your site without having to contact the + # advertiser. You can use keywords to dynamically change the look or + # functionality of a creative. Applicable to the following creative types: all + # RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `adTagKeys` + # @return [Array] + attr_accessor :ad_tag_keys + + # Advertiser ID of this creative. This is a required field. Applicable to all + # creative types. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Whether script access is allowed for this creative. This is a read-only and + # deprecated field which will automatically be set to true on update. Applicable + # to the following creative types: FLASH_INPAGE. + # Corresponds to the JSON property `allowScriptAccess` + # @return [Boolean] + attr_accessor :allow_script_access + alias_method :allow_script_access?, :allow_script_access + + # Whether the creative is archived. Applicable to all creative types. + # Corresponds to the JSON property `archived` + # @return [Boolean] + attr_accessor :archived + alias_method :archived?, :archived + + # Type of artwork used for the creative. This is a read-only field. Applicable + # to the following creative types: all RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `artworkType` + # @return [String] + attr_accessor :artwork_type + + # Source application where creative was authored. Presently, only DBM authored + # creatives will have this field set. Applicable to all creative types. + # Corresponds to the JSON property `authoringSource` + # @return [String] + attr_accessor :authoring_source + + # Authoring tool for HTML5 banner creatives. This is a read-only field. + # Applicable to the following creative types: HTML5_BANNER. + # Corresponds to the JSON property `authoringTool` + # @return [String] + attr_accessor :authoring_tool + + # Whether images are automatically advanced for image gallery creatives. + # Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. + # Corresponds to the JSON property `autoAdvanceImages` + # @return [Boolean] + attr_accessor :auto_advance_images + alias_method :auto_advance_images?, :auto_advance_images + + # The 6-character HTML color code, beginning with #, for the background of the + # window area where the Flash file is displayed. Default is white. Applicable to + # the following creative types: FLASH_INPAGE. + # Corresponds to the JSON property `backgroundColor` + # @return [String] + attr_accessor :background_color + + # Click-through URL + # Corresponds to the JSON property `backupImageClickThroughUrl` + # @return [Google::Apis::DfareportingV3_0::CreativeClickThroughUrl] + attr_accessor :backup_image_click_through_url + + # List of feature dependencies that will cause a backup image to be served if + # the browser that serves the ad does not support them. Feature dependencies are + # features that a browser must be able to support in order to render your HTML5 + # creative asset correctly. This field is initially auto-generated to contain + # all features detected by DCM for all the assets of this creative and can then + # be modified by the client. To reset this field, copy over all the + # creativeAssets' detected features. Applicable to the following creative types: + # HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not + # HTML_IMAGE. + # Corresponds to the JSON property `backupImageFeatures` + # @return [Array] + attr_accessor :backup_image_features + + # Reporting label used for HTML5 banner backup image. Applicable to the + # following creative types: DISPLAY when the primary asset type is not + # HTML_IMAGE. + # Corresponds to the JSON property `backupImageReportingLabel` + # @return [String] + attr_accessor :backup_image_reporting_label + + # Target Window. + # Corresponds to the JSON property `backupImageTargetWindow` + # @return [Google::Apis::DfareportingV3_0::TargetWindow] + attr_accessor :backup_image_target_window + + # Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER + # creatives, this is a subset of detected click tags for the assets associated + # with this creative. After creating a flash asset, detected click tags will be + # returned in the creativeAssetMetadata. When inserting the creative, populate + # the creative clickTags field using the creativeAssetMetadata.clickTags field. + # For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this + # list for each image creative asset. A click tag is matched with a + # corresponding creative asset by matching the clickTag.name field with the + # creativeAsset.assetIdentifier.name field. Applicable to the following creative + # types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to + # DISPLAY when the primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `clickTags` + # @return [Array] + attr_accessor :click_tags + + # Industry standard ID assigned to creative for reach and frequency. Applicable + # to INSTREAM_VIDEO_REDIRECT creatives. + # Corresponds to the JSON property `commercialId` + # @return [String] + attr_accessor :commercial_id + + # List of companion creatives assigned to an in-Stream videocreative. Acceptable + # values include IDs of existing flash and image creatives. Applicable to the + # following creative types: all VPAID and all INSTREAM_VIDEO with + # dynamicAssetSelection set to false. + # Corresponds to the JSON property `companionCreatives` + # @return [Array] + attr_accessor :companion_creatives + + # Compatibilities associated with this creative. This is a read-only field. + # DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on + # mobile devices or in mobile apps for regular or interstitial ads, respectively. + # APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing + # creatives may have these compatibilities since new creatives will either be + # assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to + # rendering in in-stream video ads developed with the VAST standard. Applicable + # to all creative types. + # Acceptable values are: + # - "APP" + # - "APP_INTERSTITIAL" + # - "IN_STREAM_VIDEO" + # - "DISPLAY" + # - "DISPLAY_INTERSTITIAL" + # Corresponds to the JSON property `compatibility` + # @return [Array] + attr_accessor :compatibility + + # Whether Flash assets associated with the creative need to be automatically + # converted to HTML5. This flag is enabled by default and users can choose to + # disable it if they don't want the system to generate and use HTML5 asset for + # this creative. Applicable to the following creative type: FLASH_INPAGE. + # Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `convertFlashToHtml5` + # @return [Boolean] + attr_accessor :convert_flash_to_html5 + alias_method :convert_flash_to_html5?, :convert_flash_to_html5 + + # List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY + # creatives, these are read-only and auto-generated from clickTags. Applicable + # to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and + # all VPAID. + # Corresponds to the JSON property `counterCustomEvents` + # @return [Array] + attr_accessor :counter_custom_events + + # Encapsulates the list of rules for asset selection and a default asset in case + # none of the rules match. Applicable to INSTREAM_VIDEO creatives. + # Corresponds to the JSON property `creativeAssetSelection` + # @return [Google::Apis::DfareportingV3_0::CreativeAssetSelection] + attr_accessor :creative_asset_selection + + # Assets associated with a creative. Applicable to all but the following + # creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and + # REDIRECT + # Corresponds to the JSON property `creativeAssets` + # @return [Array] + attr_accessor :creative_assets + + # Creative field assignments for this creative. Applicable to all creative types. + # Corresponds to the JSON property `creativeFieldAssignments` + # @return [Array] + attr_accessor :creative_field_assignments + + # Custom key-values for a Rich Media creative. Key-values let you customize the + # creative settings of a Rich Media ad running on your site without having to + # contact the advertiser. You can use key-values to dynamically change the look + # or functionality of a creative. Applicable to the following creative types: + # all RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `customKeyValues` + # @return [Array] + attr_accessor :custom_key_values + + # Set this to true to enable the use of rules to target individual assets in + # this creative. When set to true creativeAssetSelection must be set. This also + # controls asset-level companions. When this is true, companion creatives should + # be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO + # creatives. + # Corresponds to the JSON property `dynamicAssetSelection` + # @return [Boolean] + attr_accessor :dynamic_asset_selection + alias_method :dynamic_asset_selection?, :dynamic_asset_selection + + # List of exit events configured for the creative. For DISPLAY and + # DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from + # clickTags, For DISPLAY, an event is also created from the + # backupImageReportingLabel. Applicable to the following creative types: + # DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY + # when the primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `exitCustomEvents` + # @return [Array] + attr_accessor :exit_custom_events + + # FsCommand. + # Corresponds to the JSON property `fsCommand` + # @return [Google::Apis::DfareportingV3_0::FsCommand] + attr_accessor :fs_command + + # HTML code for the creative. This is a required field when applicable. This + # field is ignored if htmlCodeLocked is true. Applicable to the following + # creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. + # Corresponds to the JSON property `htmlCode` + # @return [String] + attr_accessor :html_code + + # Whether HTML code is DCM-generated or manually entered. Set to true to ignore + # changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE + # and HTML5_BANNER. + # Corresponds to the JSON property `htmlCodeLocked` + # @return [Boolean] + attr_accessor :html_code_locked + alias_method :html_code_locked?, :html_code_locked + + # ID of this creative. This is a read-only, auto-generated field. Applicable to + # all creative types. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :id_dimension_value + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creative". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] + attr_accessor :last_modified_info + + # Latest Studio trafficked creative ID associated with rich media and VPAID + # creatives. This is a read-only field. Applicable to the following creative + # types: all RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `latestTraffickedCreativeId` + # @return [Fixnum] + attr_accessor :latest_trafficked_creative_id + + # Name of the creative. This is a required field and must be less than 256 + # characters long. Applicable to all creative types. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Override CSS value for rich media creatives. Applicable to the following + # creative types: all RICH_MEDIA. + # Corresponds to the JSON property `overrideCss` + # @return [String] + attr_accessor :override_css + + # The asset ID of the polite load image asset. Applicable to the creative type: + # DISPLAY. + # Corresponds to the JSON property `politeLoadAssetId` + # @return [Fixnum] + attr_accessor :polite_load_asset_id + + # Video Offset + # Corresponds to the JSON property `progressOffset` + # @return [Google::Apis::DfareportingV3_0::VideoOffset] + attr_accessor :progress_offset + + # URL of hosted image or hosted video or another ad tag. For + # INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. + # The standard for a VAST (Video Ad Serving Template) ad response allows for a + # redirect link to another VAST 2.0 or 3.0 call. This is a required field when + # applicable. Applicable to the following creative types: DISPLAY_REDIRECT, + # INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT + # Corresponds to the JSON property `redirectUrl` + # @return [String] + attr_accessor :redirect_url + + # ID of current rendering version. This is a read-only field. Applicable to all + # creative types. + # Corresponds to the JSON property `renderingId` + # @return [Fixnum] + attr_accessor :rendering_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `renderingIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :rendering_id_dimension_value + + # The minimum required Flash plugin version for this creative. For example, 11.2. + # 202.235. This is a read-only field. Applicable to the following creative types: + # all RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `requiredFlashPluginVersion` + # @return [String] + attr_accessor :required_flash_plugin_version + + # The internal Flash version for this creative as calculated by DoubleClick + # Studio. This is a read-only field. Applicable to the following creative types: + # FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the + # primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `requiredFlashVersion` + # @return [Fixnum] + attr_accessor :required_flash_version + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `size` + # @return [Google::Apis::DfareportingV3_0::Size] + attr_accessor :size + + # Video Offset + # Corresponds to the JSON property `skipOffset` + # @return [Google::Apis::DfareportingV3_0::VideoOffset] + attr_accessor :skip_offset + + # Whether the user can choose to skip the creative. Applicable to the following + # creative types: all INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `skippable` + # @return [Boolean] + attr_accessor :skippable + alias_method :skippable?, :skippable + + # Whether the creative is SSL-compliant. This is a read-only field. Applicable + # to all creative types. + # Corresponds to the JSON property `sslCompliant` + # @return [Boolean] + attr_accessor :ssl_compliant + alias_method :ssl_compliant?, :ssl_compliant + + # Whether creative should be treated as SSL compliant even if the system scan + # shows it's not. Applicable to all creative types. + # Corresponds to the JSON property `sslOverride` + # @return [Boolean] + attr_accessor :ssl_override + alias_method :ssl_override?, :ssl_override + + # Studio advertiser ID associated with rich media and VPAID creatives. This is a + # read-only field. Applicable to the following creative types: all RICH_MEDIA, + # and all VPAID. + # Corresponds to the JSON property `studioAdvertiserId` + # @return [Fixnum] + attr_accessor :studio_advertiser_id + + # Studio creative ID associated with rich media and VPAID creatives. This is a + # read-only field. Applicable to the following creative types: all RICH_MEDIA, + # and all VPAID. + # Corresponds to the JSON property `studioCreativeId` + # @return [Fixnum] + attr_accessor :studio_creative_id + + # Studio trafficked creative ID associated with rich media and VPAID creatives. + # This is a read-only field. Applicable to the following creative types: all + # RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `studioTraffickedCreativeId` + # @return [Fixnum] + attr_accessor :studio_trafficked_creative_id + + # Subaccount ID of this creative. This field, if left unset, will be auto- + # generated for both insert and update operations. Applicable to all creative + # types. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Third-party URL used to record backup image impressions. Applicable to the + # following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `thirdPartyBackupImageImpressionsUrl` + # @return [String] + attr_accessor :third_party_backup_image_impressions_url + + # Third-party URL used to record rich media impressions. Applicable to the + # following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `thirdPartyRichMediaImpressionsUrl` + # @return [String] + attr_accessor :third_party_rich_media_impressions_url + + # Third-party URLs for tracking in-stream video creative events. Applicable to + # the following creative types: all INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `thirdPartyUrls` + # @return [Array] + attr_accessor :third_party_urls + + # List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY + # creatives, these are read-only and auto-generated from clickTags. Applicable + # to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and + # all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE. + # Corresponds to the JSON property `timerCustomEvents` + # @return [Array] + attr_accessor :timer_custom_events + + # Combined size of all creative assets. This is a read-only field. Applicable to + # the following creative types: all RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `totalFileSize` + # @return [Fixnum] + attr_accessor :total_file_size + + # Type of this creative. This is a required field. Applicable to all creative + # types. + # Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing + # creatives. New creatives should use DISPLAY as a replacement for these types. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following + # creative types: INSTREAM_VIDEO and VPAID. + # Corresponds to the JSON property `universalAdId` + # @return [Google::Apis::DfareportingV3_0::UniversalAdId] + attr_accessor :universal_ad_id + + # The version number helps you keep track of multiple versions of your creative + # in your reports. The version number will always be auto-generated during + # insert operations to start at 1. For tracking creatives the version cannot be + # incremented and will always remain at 1. For all other creative types the + # version can be incremented only by 1 during update operations. In addition, + # the version will be automatically incremented by 1 when undergoing Rich Media + # creative merging. Applicable to all creative types. + # Corresponds to the JSON property `version` + # @return [Fixnum] + attr_accessor :version + + # Description of the video ad. Applicable to the following creative types: all + # INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `videoDescription` + # @return [String] + attr_accessor :video_description + + # Creative video duration in seconds. This is a read-only field. Applicable to + # the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID. + # Corresponds to the JSON property `videoDuration` + # @return [Float] + attr_accessor :video_duration + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @active = args[:active] if args.key?(:active) + @ad_parameters = args[:ad_parameters] if args.key?(:ad_parameters) + @ad_tag_keys = args[:ad_tag_keys] if args.key?(:ad_tag_keys) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @allow_script_access = args[:allow_script_access] if args.key?(:allow_script_access) + @archived = args[:archived] if args.key?(:archived) + @artwork_type = args[:artwork_type] if args.key?(:artwork_type) + @authoring_source = args[:authoring_source] if args.key?(:authoring_source) + @authoring_tool = args[:authoring_tool] if args.key?(:authoring_tool) + @auto_advance_images = args[:auto_advance_images] if args.key?(:auto_advance_images) + @background_color = args[:background_color] if args.key?(:background_color) + @backup_image_click_through_url = args[:backup_image_click_through_url] if args.key?(:backup_image_click_through_url) + @backup_image_features = args[:backup_image_features] if args.key?(:backup_image_features) + @backup_image_reporting_label = args[:backup_image_reporting_label] if args.key?(:backup_image_reporting_label) + @backup_image_target_window = args[:backup_image_target_window] if args.key?(:backup_image_target_window) + @click_tags = args[:click_tags] if args.key?(:click_tags) + @commercial_id = args[:commercial_id] if args.key?(:commercial_id) + @companion_creatives = args[:companion_creatives] if args.key?(:companion_creatives) + @compatibility = args[:compatibility] if args.key?(:compatibility) + @convert_flash_to_html5 = args[:convert_flash_to_html5] if args.key?(:convert_flash_to_html5) + @counter_custom_events = args[:counter_custom_events] if args.key?(:counter_custom_events) + @creative_asset_selection = args[:creative_asset_selection] if args.key?(:creative_asset_selection) + @creative_assets = args[:creative_assets] if args.key?(:creative_assets) + @creative_field_assignments = args[:creative_field_assignments] if args.key?(:creative_field_assignments) + @custom_key_values = args[:custom_key_values] if args.key?(:custom_key_values) + @dynamic_asset_selection = args[:dynamic_asset_selection] if args.key?(:dynamic_asset_selection) + @exit_custom_events = args[:exit_custom_events] if args.key?(:exit_custom_events) + @fs_command = args[:fs_command] if args.key?(:fs_command) + @html_code = args[:html_code] if args.key?(:html_code) + @html_code_locked = args[:html_code_locked] if args.key?(:html_code_locked) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @kind = args[:kind] if args.key?(:kind) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @latest_trafficked_creative_id = args[:latest_trafficked_creative_id] if args.key?(:latest_trafficked_creative_id) + @name = args[:name] if args.key?(:name) + @override_css = args[:override_css] if args.key?(:override_css) + @polite_load_asset_id = args[:polite_load_asset_id] if args.key?(:polite_load_asset_id) + @progress_offset = args[:progress_offset] if args.key?(:progress_offset) + @redirect_url = args[:redirect_url] if args.key?(:redirect_url) + @rendering_id = args[:rendering_id] if args.key?(:rendering_id) + @rendering_id_dimension_value = args[:rendering_id_dimension_value] if args.key?(:rendering_id_dimension_value) + @required_flash_plugin_version = args[:required_flash_plugin_version] if args.key?(:required_flash_plugin_version) + @required_flash_version = args[:required_flash_version] if args.key?(:required_flash_version) + @size = args[:size] if args.key?(:size) + @skip_offset = args[:skip_offset] if args.key?(:skip_offset) + @skippable = args[:skippable] if args.key?(:skippable) + @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) + @ssl_override = args[:ssl_override] if args.key?(:ssl_override) + @studio_advertiser_id = args[:studio_advertiser_id] if args.key?(:studio_advertiser_id) + @studio_creative_id = args[:studio_creative_id] if args.key?(:studio_creative_id) + @studio_trafficked_creative_id = args[:studio_trafficked_creative_id] if args.key?(:studio_trafficked_creative_id) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @third_party_backup_image_impressions_url = args[:third_party_backup_image_impressions_url] if args.key?(:third_party_backup_image_impressions_url) + @third_party_rich_media_impressions_url = args[:third_party_rich_media_impressions_url] if args.key?(:third_party_rich_media_impressions_url) + @third_party_urls = args[:third_party_urls] if args.key?(:third_party_urls) + @timer_custom_events = args[:timer_custom_events] if args.key?(:timer_custom_events) + @total_file_size = args[:total_file_size] if args.key?(:total_file_size) + @type = args[:type] if args.key?(:type) + @universal_ad_id = args[:universal_ad_id] if args.key?(:universal_ad_id) + @version = args[:version] if args.key?(:version) + @video_description = args[:video_description] if args.key?(:video_description) + @video_duration = args[:video_duration] if args.key?(:video_duration) + end + end + + # Creative Asset. + class CreativeAsset + include Google::Apis::Core::Hashable + + # Whether ActionScript3 is enabled for the flash asset. This is a read-only + # field. Applicable to the following creative type: FLASH_INPAGE. Applicable to + # DISPLAY when the primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `actionScript3` + # @return [Boolean] + attr_accessor :action_script3 + alias_method :action_script3?, :action_script3 + + # Whether the video asset is active. This is a read-only field for + # VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: + # INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Possible alignments for an asset. This is a read-only field. Applicable to the + # following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. + # Corresponds to the JSON property `alignment` + # @return [String] + attr_accessor :alignment + + # Artwork type of rich media creative. This is a read-only field. Applicable to + # the following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `artworkType` + # @return [String] + attr_accessor :artwork_type + + # Creative Asset ID. + # Corresponds to the JSON property `assetIdentifier` + # @return [Google::Apis::DfareportingV3_0::CreativeAssetId] + attr_accessor :asset_identifier + + # Creative Custom Event. + # Corresponds to the JSON property `backupImageExit` + # @return [Google::Apis::DfareportingV3_0::CreativeCustomEvent] + attr_accessor :backup_image_exit + + # Detected bit-rate for video asset. This is a read-only field. Applicable to + # the following creative types: INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `bitRate` + # @return [Fixnum] + attr_accessor :bit_rate + + # Rich media child asset type. This is a read-only field. Applicable to the + # following creative types: all VPAID. + # Corresponds to the JSON property `childAssetType` + # @return [String] + attr_accessor :child_asset_type + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `collapsedSize` + # @return [Google::Apis::DfareportingV3_0::Size] + attr_accessor :collapsed_size + + # List of companion creatives assigned to an in-stream video creative asset. + # Acceptable values include IDs of existing flash and image creatives. + # Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to + # true. + # Corresponds to the JSON property `companionCreativeIds` + # @return [Array] + attr_accessor :companion_creative_ids + + # Custom start time in seconds for making the asset visible. Applicable to the + # following creative types: all RICH_MEDIA. Value must be greater than or equal + # to 0. + # Corresponds to the JSON property `customStartTimeValue` + # @return [Fixnum] + attr_accessor :custom_start_time_value + + # List of feature dependencies for the creative asset that are detected by DCM. + # Feature dependencies are features that a browser must be able to support in + # order to render your HTML5 creative correctly. This is a read-only, auto- + # generated field. Applicable to the following creative types: HTML5_BANNER. + # Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `detectedFeatures` + # @return [Array] + attr_accessor :detected_features + + # Type of rich media asset. This is a read-only field. Applicable to the + # following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `displayType` + # @return [String] + attr_accessor :display_type + + # Duration in seconds for which an asset will be displayed. Applicable to the + # following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be + # greater than or equal to 1. + # Corresponds to the JSON property `duration` + # @return [Fixnum] + attr_accessor :duration + + # Duration type for which an asset will be displayed. Applicable to the + # following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `durationType` + # @return [String] + attr_accessor :duration_type + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `expandedDimension` + # @return [Google::Apis::DfareportingV3_0::Size] + attr_accessor :expanded_dimension + + # File size associated with this creative asset. This is a read-only field. + # Applicable to all but the following creative types: all REDIRECT and + # TRACKING_TEXT. + # Corresponds to the JSON property `fileSize` + # @return [Fixnum] + attr_accessor :file_size + + # Flash version of the asset. This is a read-only field. Applicable to the + # following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. + # Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + # Corresponds to the JSON property `flashVersion` + # @return [Fixnum] + attr_accessor :flash_version + + # Whether to hide Flash objects flag for an asset. Applicable to the following + # creative types: all RICH_MEDIA. + # Corresponds to the JSON property `hideFlashObjects` + # @return [Boolean] + attr_accessor :hide_flash_objects + alias_method :hide_flash_objects?, :hide_flash_objects + + # Whether to hide selection boxes flag for an asset. Applicable to the following + # creative types: all RICH_MEDIA. + # Corresponds to the JSON property `hideSelectionBoxes` + # @return [Boolean] + attr_accessor :hide_selection_boxes + alias_method :hide_selection_boxes?, :hide_selection_boxes + + # Whether the asset is horizontally locked. This is a read-only field. + # Applicable to the following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `horizontallyLocked` + # @return [Boolean] + attr_accessor :horizontally_locked + alias_method :horizontally_locked?, :horizontally_locked + + # Numeric ID of this creative asset. This is a required field and should not be + # modified. Applicable to all but the following creative types: all REDIRECT and + # TRACKING_TEXT. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :id_dimension_value + + # Detected MIME type for video asset. This is a read-only field. Applicable to + # the following creative types: INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `mimeType` + # @return [String] + attr_accessor :mime_type + + # Offset Position. + # Corresponds to the JSON property `offset` + # @return [Google::Apis::DfareportingV3_0::OffsetPosition] + attr_accessor :offset + + # Orientation of video asset. This is a read-only, auto-generated field. + # Corresponds to the JSON property `orientation` + # @return [String] + attr_accessor :orientation + + # Whether the backup asset is original or changed by the user in DCM. Applicable + # to the following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `originalBackup` + # @return [Boolean] + attr_accessor :original_backup + alias_method :original_backup?, :original_backup + + # Offset Position. + # Corresponds to the JSON property `position` + # @return [Google::Apis::DfareportingV3_0::OffsetPosition] + attr_accessor :position + + # Offset left unit for an asset. This is a read-only field. Applicable to the + # following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `positionLeftUnit` + # @return [String] + attr_accessor :position_left_unit + + # Offset top unit for an asset. This is a read-only field if the asset + # displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following + # creative types: all RICH_MEDIA. + # Corresponds to the JSON property `positionTopUnit` + # @return [String] + attr_accessor :position_top_unit + + # Progressive URL for video asset. This is a read-only field. Applicable to the + # following creative types: INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `progressiveServingUrl` + # @return [String] + attr_accessor :progressive_serving_url + + # Whether the asset pushes down other content. Applicable to the following + # creative types: all RICH_MEDIA. Additionally, only applicable when the asset + # offsets are 0, the collapsedSize.width matches size.width, and the + # collapsedSize.height is less than size.height. + # Corresponds to the JSON property `pushdown` + # @return [Boolean] + attr_accessor :pushdown + alias_method :pushdown?, :pushdown + + # Pushdown duration in seconds for an asset. Applicable to the following + # creative types: all RICH_MEDIA.Additionally, only applicable when the asset + # pushdown field is true, the offsets are 0, the collapsedSize.width matches + # size.width, and the collapsedSize.height is less than size.height. Acceptable + # values are 0 to 9.99, inclusive. + # Corresponds to the JSON property `pushdownDuration` + # @return [Float] + attr_accessor :pushdown_duration + + # Role of the asset in relation to creative. Applicable to all but the following + # creative types: all REDIRECT and TRACKING_TEXT. This is a required field. + # PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, + # DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary + # assets), and all VPAID creatives. + # BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all + # VPAID creatives. Applicable to DISPLAY when the primary asset type is not + # HTML_IMAGE. + # ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. + # OTHER refers to assets from sources other than DCM, such as Studio uploaded + # assets, applicable to all RICH_MEDIA and all VPAID creatives. + # PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to + # INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. + # TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets + # and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. + # ALTERNATE_VIDEO refers to the DCM representation of child asset videos from + # Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be + # added or removed within DCM. + # For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and + # ALTERNATE_VIDEO assets that are marked active serve as backup in case the + # VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or + # removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. + # Corresponds to the JSON property `role` + # @return [String] + attr_accessor :role + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `size` + # @return [Google::Apis::DfareportingV3_0::Size] + attr_accessor :size + + # Whether the asset is SSL-compliant. This is a read-only field. Applicable to + # all but the following creative types: all REDIRECT and TRACKING_TEXT. + # Corresponds to the JSON property `sslCompliant` + # @return [Boolean] + attr_accessor :ssl_compliant + alias_method :ssl_compliant?, :ssl_compliant + + # Initial wait time type before making the asset visible. Applicable to the + # following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `startTimeType` + # @return [String] + attr_accessor :start_time_type + + # Streaming URL for video asset. This is a read-only field. Applicable to the + # following creative types: INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `streamingServingUrl` + # @return [String] + attr_accessor :streaming_serving_url + + # Whether the asset is transparent. Applicable to the following creative types: + # all RICH_MEDIA. Additionally, only applicable to HTML5 assets. + # Corresponds to the JSON property `transparency` + # @return [Boolean] + attr_accessor :transparency + alias_method :transparency?, :transparency + + # Whether the asset is vertically locked. This is a read-only field. Applicable + # to the following creative types: all RICH_MEDIA. + # Corresponds to the JSON property `verticallyLocked` + # @return [Boolean] + attr_accessor :vertically_locked + alias_method :vertically_locked?, :vertically_locked + + # Detected video duration for video asset. This is a read-only field. Applicable + # to the following creative types: INSTREAM_VIDEO and all VPAID. + # Corresponds to the JSON property `videoDuration` + # @return [Float] + attr_accessor :video_duration + + # Window mode options for flash assets. Applicable to the following creative + # types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, + # RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING. + # Corresponds to the JSON property `windowMode` + # @return [String] + attr_accessor :window_mode + + # zIndex value of an asset. Applicable to the following creative types: all + # RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT + # one of the following types: ASSET_DISPLAY_TYPE_INPAGE or + # ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, + # inclusive. + # Corresponds to the JSON property `zIndex` + # @return [Fixnum] + attr_accessor :z_index + + # File name of zip file. This is a read-only field. Applicable to the following + # creative types: HTML5_BANNER. + # Corresponds to the JSON property `zipFilename` + # @return [String] + attr_accessor :zip_filename + + # Size of zip file. This is a read-only field. Applicable to the following + # creative types: HTML5_BANNER. + # Corresponds to the JSON property `zipFilesize` + # @return [String] + attr_accessor :zip_filesize + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action_script3 = args[:action_script3] if args.key?(:action_script3) + @active = args[:active] if args.key?(:active) + @alignment = args[:alignment] if args.key?(:alignment) + @artwork_type = args[:artwork_type] if args.key?(:artwork_type) + @asset_identifier = args[:asset_identifier] if args.key?(:asset_identifier) + @backup_image_exit = args[:backup_image_exit] if args.key?(:backup_image_exit) + @bit_rate = args[:bit_rate] if args.key?(:bit_rate) + @child_asset_type = args[:child_asset_type] if args.key?(:child_asset_type) + @collapsed_size = args[:collapsed_size] if args.key?(:collapsed_size) + @companion_creative_ids = args[:companion_creative_ids] if args.key?(:companion_creative_ids) + @custom_start_time_value = args[:custom_start_time_value] if args.key?(:custom_start_time_value) + @detected_features = args[:detected_features] if args.key?(:detected_features) + @display_type = args[:display_type] if args.key?(:display_type) + @duration = args[:duration] if args.key?(:duration) + @duration_type = args[:duration_type] if args.key?(:duration_type) + @expanded_dimension = args[:expanded_dimension] if args.key?(:expanded_dimension) + @file_size = args[:file_size] if args.key?(:file_size) + @flash_version = args[:flash_version] if args.key?(:flash_version) + @hide_flash_objects = args[:hide_flash_objects] if args.key?(:hide_flash_objects) + @hide_selection_boxes = args[:hide_selection_boxes] if args.key?(:hide_selection_boxes) + @horizontally_locked = args[:horizontally_locked] if args.key?(:horizontally_locked) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @mime_type = args[:mime_type] if args.key?(:mime_type) + @offset = args[:offset] if args.key?(:offset) + @orientation = args[:orientation] if args.key?(:orientation) + @original_backup = args[:original_backup] if args.key?(:original_backup) + @position = args[:position] if args.key?(:position) + @position_left_unit = args[:position_left_unit] if args.key?(:position_left_unit) + @position_top_unit = args[:position_top_unit] if args.key?(:position_top_unit) + @progressive_serving_url = args[:progressive_serving_url] if args.key?(:progressive_serving_url) + @pushdown = args[:pushdown] if args.key?(:pushdown) + @pushdown_duration = args[:pushdown_duration] if args.key?(:pushdown_duration) + @role = args[:role] if args.key?(:role) + @size = args[:size] if args.key?(:size) + @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) + @start_time_type = args[:start_time_type] if args.key?(:start_time_type) + @streaming_serving_url = args[:streaming_serving_url] if args.key?(:streaming_serving_url) + @transparency = args[:transparency] if args.key?(:transparency) + @vertically_locked = args[:vertically_locked] if args.key?(:vertically_locked) + @video_duration = args[:video_duration] if args.key?(:video_duration) + @window_mode = args[:window_mode] if args.key?(:window_mode) + @z_index = args[:z_index] if args.key?(:z_index) + @zip_filename = args[:zip_filename] if args.key?(:zip_filename) + @zip_filesize = args[:zip_filesize] if args.key?(:zip_filesize) + end + end + + # Creative Asset ID. + class CreativeAssetId + include Google::Apis::Core::Hashable + + # Name of the creative asset. This is a required field while inserting an asset. + # After insertion, this assetIdentifier is used to identify the uploaded asset. + # Characters in the name must be alphanumeric or one of the following: ".-_ ". + # Spaces are allowed. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Type of asset to upload. This is a required field. FLASH and IMAGE are no + # longer supported for new uploads. All image assets should use HTML_IMAGE. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @type = args[:type] if args.key?(:type) + end + end + + # CreativeAssets contains properties of a creative asset file which will be + # uploaded or has already been uploaded. Refer to the creative sample code for + # how to upload assets and insert a creative. + class CreativeAssetMetadata + include Google::Apis::Core::Hashable + + # Creative Asset ID. + # Corresponds to the JSON property `assetIdentifier` + # @return [Google::Apis::DfareportingV3_0::CreativeAssetId] + attr_accessor :asset_identifier + + # List of detected click tags for assets. This is a read-only auto-generated + # field. + # Corresponds to the JSON property `clickTags` + # @return [Array] + attr_accessor :click_tags + + # List of feature dependencies for the creative asset that are detected by DCM. + # Feature dependencies are features that a browser must be able to support in + # order to render your HTML5 creative correctly. This is a read-only, auto- + # generated field. + # Corresponds to the JSON property `detectedFeatures` + # @return [Array] + attr_accessor :detected_features + + # Numeric ID of the asset. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :id_dimension_value + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativeAssetMetadata". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Rules validated during code generation that generated a warning. This is a + # read-only, auto-generated field. + # Possible values are: + # - "ADMOB_REFERENCED" + # - "ASSET_FORMAT_UNSUPPORTED_DCM" + # - "ASSET_INVALID" + # - "CLICK_TAG_HARD_CODED" + # - "CLICK_TAG_INVALID" + # - "CLICK_TAG_IN_GWD" + # - "CLICK_TAG_MISSING" + # - "CLICK_TAG_MORE_THAN_ONE" + # - "CLICK_TAG_NON_TOP_LEVEL" + # - "COMPONENT_UNSUPPORTED_DCM" + # - "ENABLER_UNSUPPORTED_METHOD_DCM" + # - "EXTERNAL_FILE_REFERENCED" + # - "FILE_DETAIL_EMPTY" + # - "FILE_TYPE_INVALID" + # - "GWD_PROPERTIES_INVALID" + # - "HTML5_FEATURE_UNSUPPORTED" + # - "LINKED_FILE_NOT_FOUND" + # - "MAX_FLASH_VERSION_11" + # - "MRAID_REFERENCED" + # - "NOT_SSL_COMPLIANT" + # - "ORPHANED_ASSET" + # - "PRIMARY_HTML_MISSING" + # - "SVG_INVALID" + # - "ZIP_INVALID" + # Corresponds to the JSON property `warnedValidationRules` + # @return [Array] + attr_accessor :warned_validation_rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @asset_identifier = args[:asset_identifier] if args.key?(:asset_identifier) + @click_tags = args[:click_tags] if args.key?(:click_tags) + @detected_features = args[:detected_features] if args.key?(:detected_features) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @kind = args[:kind] if args.key?(:kind) + @warned_validation_rules = args[:warned_validation_rules] if args.key?(:warned_validation_rules) + end + end + + # Encapsulates the list of rules for asset selection and a default asset in case + # none of the rules match. Applicable to INSTREAM_VIDEO creatives. + class CreativeAssetSelection + include Google::Apis::Core::Hashable + + # A creativeAssets[].id. This should refer to one of the parent assets in this + # creative, and will be served if none of the rules match. This is a required + # field. + # Corresponds to the JSON property `defaultAssetId` + # @return [Fixnum] + attr_accessor :default_asset_id + + # Rules determine which asset will be served to a viewer. Rules will be + # evaluated in the order in which they are stored in this list. This list must + # contain at least one rule. Applicable to INSTREAM_VIDEO creatives. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @default_asset_id = args[:default_asset_id] if args.key?(:default_asset_id) + @rules = args[:rules] if args.key?(:rules) + end + end + + # Creative Assignment. + class CreativeAssignment + include Google::Apis::Core::Hashable + + # Whether this creative assignment is active. When true, the creative will be + # included in the ad's rotation. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Whether applicable event tags should fire when this creative assignment is + # rendered. If this value is unset when the ad is inserted or updated, it will + # default to true for all creative types EXCEPT for INTERNAL_REDIRECT, + # INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. + # Corresponds to the JSON property `applyEventTags` + # @return [Boolean] + attr_accessor :apply_event_tags + alias_method :apply_event_tags?, :apply_event_tags + + # Click-through URL + # Corresponds to the JSON property `clickThroughUrl` + # @return [Google::Apis::DfareportingV3_0::ClickThroughUrl] + attr_accessor :click_through_url + + # Companion creative overrides for this creative assignment. Applicable to video + # ads. + # Corresponds to the JSON property `companionCreativeOverrides` + # @return [Array] + attr_accessor :companion_creative_overrides + + # Creative group assignments for this creative assignment. Only one assignment + # per creative group number is allowed for a maximum of two assignments. + # Corresponds to the JSON property `creativeGroupAssignments` + # @return [Array] + attr_accessor :creative_group_assignments + + # ID of the creative to be assigned. This is a required field. + # Corresponds to the JSON property `creativeId` + # @return [Fixnum] + attr_accessor :creative_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `creativeIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :creative_id_dimension_value + + # Date and time that the assigned creative should stop serving. Must be later + # than the start time. + # Corresponds to the JSON property `endTime` + # @return [DateTime] + attr_accessor :end_time + + # Rich media exit overrides for this creative assignment. + # Applicable when the creative type is any of the following: + # - DISPLAY + # - RICH_MEDIA_INPAGE + # - RICH_MEDIA_INPAGE_FLOATING + # - RICH_MEDIA_IM_EXPAND + # - RICH_MEDIA_EXPANDING + # - RICH_MEDIA_INTERSTITIAL_FLOAT + # - RICH_MEDIA_MOBILE_IN_APP + # - RICH_MEDIA_MULTI_FLOATING + # - RICH_MEDIA_PEEL_DOWN + # - VPAID_LINEAR + # - VPAID_NON_LINEAR + # Corresponds to the JSON property `richMediaExitOverrides` + # @return [Array] + attr_accessor :rich_media_exit_overrides + + # Sequence number of the creative assignment, applicable when the rotation type + # is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to 65535, + # inclusive. + # Corresponds to the JSON property `sequence` + # @return [Fixnum] + attr_accessor :sequence + + # Whether the creative to be assigned is SSL-compliant. This is a read-only + # field that is auto-generated when the ad is inserted or updated. + # Corresponds to the JSON property `sslCompliant` + # @return [Boolean] + attr_accessor :ssl_compliant + alias_method :ssl_compliant?, :ssl_compliant + + # Date and time that the assigned creative should start serving. + # Corresponds to the JSON property `startTime` + # @return [DateTime] + attr_accessor :start_time + + # Weight of the creative assignment, applicable when the rotation type is + # CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. + # Corresponds to the JSON property `weight` + # @return [Fixnum] + attr_accessor :weight + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active = args[:active] if args.key?(:active) + @apply_event_tags = args[:apply_event_tags] if args.key?(:apply_event_tags) + @click_through_url = args[:click_through_url] if args.key?(:click_through_url) + @companion_creative_overrides = args[:companion_creative_overrides] if args.key?(:companion_creative_overrides) + @creative_group_assignments = args[:creative_group_assignments] if args.key?(:creative_group_assignments) + @creative_id = args[:creative_id] if args.key?(:creative_id) + @creative_id_dimension_value = args[:creative_id_dimension_value] if args.key?(:creative_id_dimension_value) + @end_time = args[:end_time] if args.key?(:end_time) + @rich_media_exit_overrides = args[:rich_media_exit_overrides] if args.key?(:rich_media_exit_overrides) + @sequence = args[:sequence] if args.key?(:sequence) + @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) + @start_time = args[:start_time] if args.key?(:start_time) + @weight = args[:weight] if args.key?(:weight) + end + end + + # Click-through URL + class CreativeClickThroughUrl + include Google::Apis::Core::Hashable + + # Read-only convenience field representing the actual URL that will be used for + # this click-through. The URL is computed as follows: + # - If landingPageId is specified then that landing page's URL is assigned to + # this field. + # - Otherwise, the customClickThroughUrl is assigned to this field. + # Corresponds to the JSON property `computedClickThroughUrl` + # @return [String] + attr_accessor :computed_click_through_url + + # Custom click-through URL. Applicable if the landingPageId field is left unset. + # Corresponds to the JSON property `customClickThroughUrl` + # @return [String] + attr_accessor :custom_click_through_url + + # ID of the landing page for the click-through URL. + # Corresponds to the JSON property `landingPageId` + # @return [Fixnum] + attr_accessor :landing_page_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @computed_click_through_url = args[:computed_click_through_url] if args.key?(:computed_click_through_url) + @custom_click_through_url = args[:custom_click_through_url] if args.key?(:custom_click_through_url) + @landing_page_id = args[:landing_page_id] if args.key?(:landing_page_id) + end + end + + # Creative Custom Event. + class CreativeCustomEvent + include Google::Apis::Core::Hashable + + # Unique ID of this event used by DDM Reporting and Data Transfer. This is a + # read-only field. + # Corresponds to the JSON property `advertiserCustomEventId` + # @return [Fixnum] + attr_accessor :advertiser_custom_event_id + + # User-entered name for the event. + # Corresponds to the JSON property `advertiserCustomEventName` + # @return [String] + attr_accessor :advertiser_custom_event_name + + # Type of the event. This is a read-only field. + # Corresponds to the JSON property `advertiserCustomEventType` + # @return [String] + attr_accessor :advertiser_custom_event_type + + # Artwork label column, used to link events in DCM back to events in Studio. + # This is a required field and should not be modified after insertion. + # Corresponds to the JSON property `artworkLabel` + # @return [String] + attr_accessor :artwork_label + + # Artwork type used by the creative.This is a read-only field. + # Corresponds to the JSON property `artworkType` + # @return [String] + attr_accessor :artwork_type + + # Click-through URL + # Corresponds to the JSON property `exitClickThroughUrl` + # @return [Google::Apis::DfareportingV3_0::CreativeClickThroughUrl] + attr_accessor :exit_click_through_url + + # ID of this event. This is a required field and should not be modified after + # insertion. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Popup Window Properties. + # Corresponds to the JSON property `popupWindowProperties` + # @return [Google::Apis::DfareportingV3_0::PopupWindowProperties] + attr_accessor :popup_window_properties + + # Target type used by the event. + # Corresponds to the JSON property `targetType` + # @return [String] + attr_accessor :target_type + + # Video reporting ID, used to differentiate multiple videos in a single creative. + # This is a read-only field. + # Corresponds to the JSON property `videoReportingId` + # @return [String] + attr_accessor :video_reporting_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_custom_event_id = args[:advertiser_custom_event_id] if args.key?(:advertiser_custom_event_id) + @advertiser_custom_event_name = args[:advertiser_custom_event_name] if args.key?(:advertiser_custom_event_name) + @advertiser_custom_event_type = args[:advertiser_custom_event_type] if args.key?(:advertiser_custom_event_type) + @artwork_label = args[:artwork_label] if args.key?(:artwork_label) + @artwork_type = args[:artwork_type] if args.key?(:artwork_type) + @exit_click_through_url = args[:exit_click_through_url] if args.key?(:exit_click_through_url) + @id = args[:id] if args.key?(:id) + @popup_window_properties = args[:popup_window_properties] if args.key?(:popup_window_properties) + @target_type = args[:target_type] if args.key?(:target_type) + @video_reporting_id = args[:video_reporting_id] if args.key?(:video_reporting_id) + end + end + + # Contains properties of a creative field. + class CreativeField + include Google::Apis::Core::Hashable + + # Account ID of this creative field. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this creative field. This is a required field on insertion. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # ID of this creative field. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativeField". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this creative field. This is a required field and must be less than + # 256 characters long and unique among creative fields of the same advertiser. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Subaccount ID of this creative field. This is a read-only field that can be + # left blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + end + end + + # Creative Field Assignment. + class CreativeFieldAssignment + include Google::Apis::Core::Hashable + + # ID of the creative field. + # Corresponds to the JSON property `creativeFieldId` + # @return [Fixnum] + attr_accessor :creative_field_id + + # ID of the creative field value. + # Corresponds to the JSON property `creativeFieldValueId` + # @return [Fixnum] + attr_accessor :creative_field_value_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_field_id = args[:creative_field_id] if args.key?(:creative_field_id) + @creative_field_value_id = args[:creative_field_value_id] if args.key?(:creative_field_value_id) + end + end + + # Contains properties of a creative field value. + class CreativeFieldValue + include Google::Apis::Core::Hashable + + # ID of this creative field value. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativeFieldValue". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Value of this creative field value. It needs to be less than 256 characters in + # length and unique per creative field. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @value = args[:value] if args.key?(:value) + end + end + + # Creative Field Value List Response + class CreativeFieldValuesListResponse + include Google::Apis::Core::Hashable + + # Creative field value collection. + # Corresponds to the JSON property `creativeFieldValues` + # @return [Array] + attr_accessor :creative_field_values + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativeFieldValuesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_field_values = args[:creative_field_values] if args.key?(:creative_field_values) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Creative Field List Response + class CreativeFieldsListResponse + include Google::Apis::Core::Hashable + + # Creative field collection. + # Corresponds to the JSON property `creativeFields` + # @return [Array] + attr_accessor :creative_fields + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativeFieldsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_fields = args[:creative_fields] if args.key?(:creative_fields) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Contains properties of a creative group. + class CreativeGroup + include Google::Apis::Core::Hashable + + # Account ID of this creative group. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this creative group. This is a required field on insertion. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Subgroup of the creative group. Assign your creative groups to a subgroup in + # order to filter or manage them more easily. This field is required on + # insertion and is read-only after insertion. Acceptable values are 1 to 2, + # inclusive. + # Corresponds to the JSON property `groupNumber` + # @return [Fixnum] + attr_accessor :group_number + + # ID of this creative group. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativeGroup". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this creative group. This is a required field and must be less than + # 256 characters long and unique among creative groups of the same advertiser. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Subaccount ID of this creative group. This is a read-only field that can be + # left blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @group_number = args[:group_number] if args.key?(:group_number) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + end + end + + # Creative Group Assignment. + class CreativeGroupAssignment + include Google::Apis::Core::Hashable + + # ID of the creative group to be assigned. + # Corresponds to the JSON property `creativeGroupId` + # @return [Fixnum] + attr_accessor :creative_group_id + + # Creative group number of the creative group assignment. + # Corresponds to the JSON property `creativeGroupNumber` + # @return [String] + attr_accessor :creative_group_number + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_group_id = args[:creative_group_id] if args.key?(:creative_group_id) + @creative_group_number = args[:creative_group_number] if args.key?(:creative_group_number) + end + end + + # Creative Group List Response + class CreativeGroupsListResponse + include Google::Apis::Core::Hashable + + # Creative group collection. + # Corresponds to the JSON property `creativeGroups` + # @return [Array] + attr_accessor :creative_groups + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativeGroupsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_groups = args[:creative_groups] if args.key?(:creative_groups) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Creative optimization settings. + class CreativeOptimizationConfiguration + include Google::Apis::Core::Hashable + + # ID of this creative optimization config. This field is auto-generated when the + # campaign is inserted or updated. It can be null for existing campaigns. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Name of this creative optimization config. This is a required field and must + # be less than 129 characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # List of optimization activities associated with this configuration. + # Corresponds to the JSON property `optimizationActivitys` + # @return [Array] + attr_accessor :optimization_activitys + + # Optimization model for this configuration. + # Corresponds to the JSON property `optimizationModel` + # @return [String] + attr_accessor :optimization_model + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @name = args[:name] if args.key?(:name) + @optimization_activitys = args[:optimization_activitys] if args.key?(:optimization_activitys) + @optimization_model = args[:optimization_model] if args.key?(:optimization_model) + end + end + + # Creative Rotation. + class CreativeRotation + include Google::Apis::Core::Hashable + + # Creative assignments in this creative rotation. + # Corresponds to the JSON property `creativeAssignments` + # @return [Array] + attr_accessor :creative_assignments + + # Creative optimization configuration that is used by this ad. It should refer + # to one of the existing optimization configurations in the ad's campaign. If it + # is unset or set to 0, then the campaign's default optimization configuration + # will be used for this ad. + # Corresponds to the JSON property `creativeOptimizationConfigurationId` + # @return [Fixnum] + attr_accessor :creative_optimization_configuration_id + + # Type of creative rotation. Can be used to specify whether to use sequential or + # random rotation. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. + # Corresponds to the JSON property `weightCalculationStrategy` + # @return [String] + attr_accessor :weight_calculation_strategy + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creative_assignments = args[:creative_assignments] if args.key?(:creative_assignments) + @creative_optimization_configuration_id = args[:creative_optimization_configuration_id] if args.key?(:creative_optimization_configuration_id) + @type = args[:type] if args.key?(:type) + @weight_calculation_strategy = args[:weight_calculation_strategy] if args.key?(:weight_calculation_strategy) + end + end + + # Creative Settings + class CreativeSettings + include Google::Apis::Core::Hashable + + # Header text for iFrames for this site. Must be less than or equal to 2000 + # characters long. + # Corresponds to the JSON property `iFrameFooter` + # @return [String] + attr_accessor :i_frame_footer + + # Header text for iFrames for this site. Must be less than or equal to 2000 + # characters long. + # Corresponds to the JSON property `iFrameHeader` + # @return [String] + attr_accessor :i_frame_header + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @i_frame_footer = args[:i_frame_footer] if args.key?(:i_frame_footer) + @i_frame_header = args[:i_frame_header] if args.key?(:i_frame_header) + end + end + + # Creative List Response + class CreativesListResponse + include Google::Apis::Core::Hashable + + # Creative collection. + # Corresponds to the JSON property `creatives` + # @return [Array] + attr_accessor :creatives + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#creativesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creatives = args[:creatives] if args.key?(:creatives) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Represents fields that are compatible to be selected for a report of type " + # CROSS_DIMENSION_REACH". + class CrossDimensionReachReportCompatibleFields + include Google::Apis::Core::Hashable + + # Dimensions which are compatible to be selected in the "breakdown" section of + # the report. + # Corresponds to the JSON property `breakdown` + # @return [Array] + attr_accessor :breakdown + + # Dimensions which are compatible to be selected in the "dimensionFilters" + # section of the report. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # The kind of resource this is, in this case dfareporting# + # crossDimensionReachReportCompatibleFields. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metrics which are compatible to be selected in the "metricNames" section of + # the report. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Metrics which are compatible to be selected in the "overlapMetricNames" + # section of the report. + # Corresponds to the JSON property `overlapMetrics` + # @return [Array] + attr_accessor :overlap_metrics + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @breakdown = args[:breakdown] if args.key?(:breakdown) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @kind = args[:kind] if args.key?(:kind) + @metrics = args[:metrics] if args.key?(:metrics) + @overlap_metrics = args[:overlap_metrics] if args.key?(:overlap_metrics) + end + end + + # A custom floodlight variable. + class CustomFloodlightVariable + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#customFloodlightVariable". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The type of custom floodlight variable to supply a value for. These map to the + # "u[1-20]=" in the tags. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # The value of the custom floodlight variable. The length of string must not + # exceed 50 characters. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @type = args[:type] if args.key?(:type) + @value = args[:value] if args.key?(:value) + end + end + + # Represents a Custom Rich Media Events group. + class CustomRichMediaEvents + include Google::Apis::Core::Hashable + + # List of custom rich media event IDs. Dimension values must be all of type dfa: + # richMediaEventTypeIdAndName. + # Corresponds to the JSON property `filteredEventIds` + # @return [Array] + attr_accessor :filtered_event_ids + + # The kind of resource this is, in this case dfareporting#customRichMediaEvents. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filtered_event_ids = args[:filtered_event_ids] if args.key?(:filtered_event_ids) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Represents a date range. + class DateRange + include Google::Apis::Core::Hashable + + # The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd" + # . + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # The kind of resource this is, in this case dfareporting#dateRange. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The date range relative to the date of when the report is run. + # Corresponds to the JSON property `relativeDateRange` + # @return [String] + attr_accessor :relative_date_range + + # The start date of the date range, inclusive. A string of the format: "yyyy-MM- + # dd". + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_date = args[:end_date] if args.key?(:end_date) + @kind = args[:kind] if args.key?(:kind) + @relative_date_range = args[:relative_date_range] if args.key?(:relative_date_range) + @start_date = args[:start_date] if args.key?(:start_date) + end + end + + # Day Part Targeting. + class DayPartTargeting + include Google::Apis::Core::Hashable + + # Days of the week when the ad will serve. + # Acceptable values are: + # - "SUNDAY" + # - "MONDAY" + # - "TUESDAY" + # - "WEDNESDAY" + # - "THURSDAY" + # - "FRIDAY" + # - "SATURDAY" + # Corresponds to the JSON property `daysOfWeek` + # @return [Array] + attr_accessor :days_of_week + + # Hours of the day when the ad will serve, where 0 is midnight to 1 AM and 23 is + # 11 PM to midnight. Can be specified with days of week, in which case the ad + # would serve during these hours on the specified days. For example if Monday, + # Wednesday, Friday are the days of week specified and 9-10am, 3-5pm (hours 9, + # 15, and 16) is specified, the ad would serve Monday, Wednesdays, and Fridays + # at 9-10am and 3-5pm. Acceptable values are 0 to 23, inclusive. + # Corresponds to the JSON property `hoursOfDay` + # @return [Array] + attr_accessor :hours_of_day + + # Whether or not to use the user's local time. If false, the America/New York + # time zone applies. + # Corresponds to the JSON property `userLocalTime` + # @return [Boolean] + attr_accessor :user_local_time + alias_method :user_local_time?, :user_local_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @days_of_week = args[:days_of_week] if args.key?(:days_of_week) + @hours_of_day = args[:hours_of_day] if args.key?(:hours_of_day) + @user_local_time = args[:user_local_time] if args.key?(:user_local_time) + end + end + + # Properties of inheriting and overriding the default click-through event tag. A + # campaign may override the event tag defined at the advertiser level, and an ad + # may also override the campaign's setting further. + class DefaultClickThroughEventTagProperties + include Google::Apis::Core::Hashable + + # ID of the click-through event tag to apply to all ads in this entity's scope. + # Corresponds to the JSON property `defaultClickThroughEventTagId` + # @return [Fixnum] + attr_accessor :default_click_through_event_tag_id + + # Whether this entity should override the inherited default click-through event + # tag with its own defined value. + # Corresponds to the JSON property `overrideInheritedEventTag` + # @return [Boolean] + attr_accessor :override_inherited_event_tag + alias_method :override_inherited_event_tag?, :override_inherited_event_tag + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @default_click_through_event_tag_id = args[:default_click_through_event_tag_id] if args.key?(:default_click_through_event_tag_id) + @override_inherited_event_tag = args[:override_inherited_event_tag] if args.key?(:override_inherited_event_tag) + end + end + + # Delivery Schedule. + class DeliverySchedule + include Google::Apis::Core::Hashable + + # Frequency Cap. + # Corresponds to the JSON property `frequencyCap` + # @return [Google::Apis::DfareportingV3_0::FrequencyCap] + attr_accessor :frequency_cap + + # Whether or not hard cutoff is enabled. If true, the ad will not serve after + # the end date and time. Otherwise the ad will continue to be served until it + # has reached its delivery goals. + # Corresponds to the JSON property `hardCutoff` + # @return [Boolean] + attr_accessor :hard_cutoff + alias_method :hard_cutoff?, :hard_cutoff + + # Impression ratio for this ad. This ratio determines how often each ad is + # served relative to the others. For example, if ad A has an impression ratio of + # 1 and ad B has an impression ratio of 3, then DCM will serve ad B three times + # as often as ad A. Acceptable values are 1 to 10, inclusive. + # Corresponds to the JSON property `impressionRatio` + # @return [Fixnum] + attr_accessor :impression_ratio + + # Serving priority of an ad, with respect to other ads. The lower the priority + # number, the greater the priority with which it is served. + # Corresponds to the JSON property `priority` + # @return [String] + attr_accessor :priority + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @frequency_cap = args[:frequency_cap] if args.key?(:frequency_cap) + @hard_cutoff = args[:hard_cutoff] if args.key?(:hard_cutoff) + @impression_ratio = args[:impression_ratio] if args.key?(:impression_ratio) + @priority = args[:priority] if args.key?(:priority) + end + end + + # DFP Settings + class DfpSettings + include Google::Apis::Core::Hashable + + # DFP network code for this directory site. + # Corresponds to the JSON property `dfpNetworkCode` + # @return [String] + attr_accessor :dfp_network_code + + # DFP network name for this directory site. + # Corresponds to the JSON property `dfpNetworkName` + # @return [String] + attr_accessor :dfp_network_name + + # Whether this directory site accepts programmatic placements. + # Corresponds to the JSON property `programmaticPlacementAccepted` + # @return [Boolean] + attr_accessor :programmatic_placement_accepted + alias_method :programmatic_placement_accepted?, :programmatic_placement_accepted + + # Whether this directory site accepts publisher-paid tags. + # Corresponds to the JSON property `pubPaidPlacementAccepted` + # @return [Boolean] + attr_accessor :pub_paid_placement_accepted + alias_method :pub_paid_placement_accepted?, :pub_paid_placement_accepted + + # Whether this directory site is available only via DoubleClick Publisher Portal. + # Corresponds to the JSON property `publisherPortalOnly` + # @return [Boolean] + attr_accessor :publisher_portal_only + alias_method :publisher_portal_only?, :publisher_portal_only + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dfp_network_code = args[:dfp_network_code] if args.key?(:dfp_network_code) + @dfp_network_name = args[:dfp_network_name] if args.key?(:dfp_network_name) + @programmatic_placement_accepted = args[:programmatic_placement_accepted] if args.key?(:programmatic_placement_accepted) + @pub_paid_placement_accepted = args[:pub_paid_placement_accepted] if args.key?(:pub_paid_placement_accepted) + @publisher_portal_only = args[:publisher_portal_only] if args.key?(:publisher_portal_only) + end + end + + # Represents a dimension. + class Dimension + include Google::Apis::Core::Hashable + + # The kind of resource this is, in this case dfareporting#dimension. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The dimension name, e.g. dfa:advertiser + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Represents a dimension filter. + class DimensionFilter + include Google::Apis::Core::Hashable + + # The name of the dimension to filter. + # Corresponds to the JSON property `dimensionName` + # @return [String] + attr_accessor :dimension_name + + # The kind of resource this is, in this case dfareporting#dimensionFilter. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The value of the dimension to filter. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_name = args[:dimension_name] if args.key?(:dimension_name) + @kind = args[:kind] if args.key?(:kind) + @value = args[:value] if args.key?(:value) + end + end + + # Represents a DimensionValue resource. + class DimensionValue + include Google::Apis::Core::Hashable + + # The name of the dimension. + # Corresponds to the JSON property `dimensionName` + # @return [String] + attr_accessor :dimension_name + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The ID associated with the value if available. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # The kind of resource this is, in this case dfareporting#dimensionValue. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Determines how the 'value' field is matched when filtering. If not specified, + # defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a + # placeholder for variable length character sequences, and it can be escaped + # with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow + # a matchType other than EXACT. + # Corresponds to the JSON property `matchType` + # @return [String] + attr_accessor :match_type + + # The value of the dimension. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_name = args[:dimension_name] if args.key?(:dimension_name) + @etag = args[:etag] if args.key?(:etag) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @match_type = args[:match_type] if args.key?(:match_type) + @value = args[:value] if args.key?(:value) + end + end + + # Represents the list of DimensionValue resources. + class DimensionValueList + include Google::Apis::Core::Hashable + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The dimension values returned in this response. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # The kind of list this is, in this case dfareporting#dimensionValueList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Continuation token used to page through dimension values. To retrieve the next + # page of results, set the next request's "pageToken" to the value of this field. + # The page token is only valid for a limited amount of time and should not be + # persisted. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Represents a DimensionValuesRequest. + class DimensionValueRequest + include Google::Apis::Core::Hashable + + # The name of the dimension for which values should be requested. + # Corresponds to the JSON property `dimensionName` + # @return [String] + attr_accessor :dimension_name + + # The end date of the date range for which to retrieve dimension values. A + # string of the format "yyyy-MM-dd". + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # The list of filters by which to filter values. The filters are ANDed. + # Corresponds to the JSON property `filters` + # @return [Array] + attr_accessor :filters + + # The kind of request this is, in this case dfareporting#dimensionValueRequest. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The start date of the date range for which to retrieve dimension values. A + # string of the format "yyyy-MM-dd". + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_name = args[:dimension_name] if args.key?(:dimension_name) + @end_date = args[:end_date] if args.key?(:end_date) + @filters = args[:filters] if args.key?(:filters) + @kind = args[:kind] if args.key?(:kind) + @start_date = args[:start_date] if args.key?(:start_date) + end + end + + # DirectorySites contains properties of a website from the Site Directory. Sites + # need to be added to an account via the Sites resource before they can be + # assigned to a placement. + class DirectorySite + include Google::Apis::Core::Hashable + + # Whether this directory site is active. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Directory site contacts. + # Corresponds to the JSON property `contactAssignments` + # @return [Array] + attr_accessor :contact_assignments + + # Country ID of this directory site. This is a read-only field. + # Corresponds to the JSON property `countryId` + # @return [Fixnum] + attr_accessor :country_id + + # Currency ID of this directory site. This is a read-only field. + # Possible values are: + # - "1" for USD + # - "2" for GBP + # - "3" for ESP + # - "4" for SEK + # - "5" for CAD + # - "6" for JPY + # - "7" for DEM + # - "8" for AUD + # - "9" for FRF + # - "10" for ITL + # - "11" for DKK + # - "12" for NOK + # - "13" for FIM + # - "14" for ZAR + # - "15" for IEP + # - "16" for NLG + # - "17" for EUR + # - "18" for KRW + # - "19" for TWD + # - "20" for SGD + # - "21" for CNY + # - "22" for HKD + # - "23" for NZD + # - "24" for MYR + # - "25" for BRL + # - "26" for PTE + # - "27" for MXP + # - "28" for CLP + # - "29" for TRY + # - "30" for ARS + # - "31" for PEN + # - "32" for ILS + # - "33" for CHF + # - "34" for VEF + # - "35" for COP + # - "36" for GTQ + # - "37" for PLN + # - "39" for INR + # - "40" for THB + # - "41" for IDR + # - "42" for CZK + # - "43" for RON + # - "44" for HUF + # - "45" for RUB + # - "46" for AED + # - "47" for BGN + # - "48" for HRK + # - "49" for MXN + # - "50" for NGN + # Corresponds to the JSON property `currencyId` + # @return [Fixnum] + attr_accessor :currency_id + + # Description of this directory site. This is a read-only field. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # ID of this directory site. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :id_dimension_value + + # Tag types for regular placements. + # Acceptable values are: + # - "STANDARD" + # - "IFRAME_JAVASCRIPT_INPAGE" + # - "INTERNAL_REDIRECT_INPAGE" + # - "JAVASCRIPT_INPAGE" + # Corresponds to the JSON property `inpageTagFormats` + # @return [Array] + attr_accessor :inpage_tag_formats + + # Tag types for interstitial placements. + # Acceptable values are: + # - "IFRAME_JAVASCRIPT_INTERSTITIAL" + # - "INTERNAL_REDIRECT_INTERSTITIAL" + # - "JAVASCRIPT_INTERSTITIAL" + # Corresponds to the JSON property `interstitialTagFormats` + # @return [Array] + attr_accessor :interstitial_tag_formats + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#directorySite". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this directory site. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Parent directory site ID. + # Corresponds to the JSON property `parentId` + # @return [Fixnum] + attr_accessor :parent_id + + # Directory Site Settings + # Corresponds to the JSON property `settings` + # @return [Google::Apis::DfareportingV3_0::DirectorySiteSettings] + attr_accessor :settings + + # URL of this directory site. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active = args[:active] if args.key?(:active) + @contact_assignments = args[:contact_assignments] if args.key?(:contact_assignments) + @country_id = args[:country_id] if args.key?(:country_id) + @currency_id = args[:currency_id] if args.key?(:currency_id) + @description = args[:description] if args.key?(:description) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @inpage_tag_formats = args[:inpage_tag_formats] if args.key?(:inpage_tag_formats) + @interstitial_tag_formats = args[:interstitial_tag_formats] if args.key?(:interstitial_tag_formats) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @parent_id = args[:parent_id] if args.key?(:parent_id) + @settings = args[:settings] if args.key?(:settings) + @url = args[:url] if args.key?(:url) + end + end + + # Contains properties of a Site Directory contact. + class DirectorySiteContact + include Google::Apis::Core::Hashable + + # Address of this directory site contact. + # Corresponds to the JSON property `address` + # @return [String] + attr_accessor :address + + # Email address of this directory site contact. + # Corresponds to the JSON property `email` + # @return [String] + attr_accessor :email + + # First name of this directory site contact. + # Corresponds to the JSON property `firstName` + # @return [String] + attr_accessor :first_name + + # ID of this directory site contact. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#directorySiteContact". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Last name of this directory site contact. + # Corresponds to the JSON property `lastName` + # @return [String] + attr_accessor :last_name + + # Phone number of this directory site contact. + # Corresponds to the JSON property `phone` + # @return [String] + attr_accessor :phone + + # Directory site contact role. + # Corresponds to the JSON property `role` + # @return [String] + attr_accessor :role + + # Title or designation of this directory site contact. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # Directory site contact type. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @address = args[:address] if args.key?(:address) + @email = args[:email] if args.key?(:email) + @first_name = args[:first_name] if args.key?(:first_name) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @last_name = args[:last_name] if args.key?(:last_name) + @phone = args[:phone] if args.key?(:phone) + @role = args[:role] if args.key?(:role) + @title = args[:title] if args.key?(:title) + @type = args[:type] if args.key?(:type) + end + end + + # Directory Site Contact Assignment + class DirectorySiteContactAssignment + include Google::Apis::Core::Hashable + + # ID of this directory site contact. This is a read-only, auto-generated field. + # Corresponds to the JSON property `contactId` + # @return [Fixnum] + attr_accessor :contact_id + + # Visibility of this directory site contact assignment. When set to PUBLIC this + # contact assignment is visible to all account and agency users; when set to + # PRIVATE it is visible only to the site. + # Corresponds to the JSON property `visibility` + # @return [String] + attr_accessor :visibility + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @contact_id = args[:contact_id] if args.key?(:contact_id) + @visibility = args[:visibility] if args.key?(:visibility) + end + end + + # Directory Site Contact List Response + class DirectorySiteContactsListResponse + include Google::Apis::Core::Hashable + + # Directory site contact collection + # Corresponds to the JSON property `directorySiteContacts` + # @return [Array] + attr_accessor :directory_site_contacts + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#directorySiteContactsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @directory_site_contacts = args[:directory_site_contacts] if args.key?(:directory_site_contacts) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Directory Site Settings + class DirectorySiteSettings + include Google::Apis::Core::Hashable + + # Whether this directory site has disabled active view creatives. + # Corresponds to the JSON property `activeViewOptOut` + # @return [Boolean] + attr_accessor :active_view_opt_out + alias_method :active_view_opt_out?, :active_view_opt_out + + # DFP Settings + # Corresponds to the JSON property `dfpSettings` + # @return [Google::Apis::DfareportingV3_0::DfpSettings] + attr_accessor :dfp_settings + + # Whether this site accepts in-stream video ads. + # Corresponds to the JSON property `instreamVideoPlacementAccepted` + # @return [Boolean] + attr_accessor :instream_video_placement_accepted + alias_method :instream_video_placement_accepted?, :instream_video_placement_accepted + + # Whether this site accepts interstitial ads. + # Corresponds to the JSON property `interstitialPlacementAccepted` + # @return [Boolean] + attr_accessor :interstitial_placement_accepted + alias_method :interstitial_placement_accepted?, :interstitial_placement_accepted + + # Whether this directory site has disabled Nielsen OCR reach ratings. + # Corresponds to the JSON property `nielsenOcrOptOut` + # @return [Boolean] + attr_accessor :nielsen_ocr_opt_out + alias_method :nielsen_ocr_opt_out?, :nielsen_ocr_opt_out + + # Whether this directory site has disabled generation of Verification ins tags. + # Corresponds to the JSON property `verificationTagOptOut` + # @return [Boolean] + attr_accessor :verification_tag_opt_out + alias_method :verification_tag_opt_out?, :verification_tag_opt_out + + # Whether this directory site has disabled active view for in-stream video + # creatives. This is a read-only field. + # Corresponds to the JSON property `videoActiveViewOptOut` + # @return [Boolean] + attr_accessor :video_active_view_opt_out + alias_method :video_active_view_opt_out?, :video_active_view_opt_out + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active_view_opt_out = args[:active_view_opt_out] if args.key?(:active_view_opt_out) + @dfp_settings = args[:dfp_settings] if args.key?(:dfp_settings) + @instream_video_placement_accepted = args[:instream_video_placement_accepted] if args.key?(:instream_video_placement_accepted) + @interstitial_placement_accepted = args[:interstitial_placement_accepted] if args.key?(:interstitial_placement_accepted) + @nielsen_ocr_opt_out = args[:nielsen_ocr_opt_out] if args.key?(:nielsen_ocr_opt_out) + @verification_tag_opt_out = args[:verification_tag_opt_out] if args.key?(:verification_tag_opt_out) + @video_active_view_opt_out = args[:video_active_view_opt_out] if args.key?(:video_active_view_opt_out) + end + end + + # Directory Site List Response + class DirectorySitesListResponse + include Google::Apis::Core::Hashable + + # Directory site collection. + # Corresponds to the JSON property `directorySites` + # @return [Array] + attr_accessor :directory_sites + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#directorySitesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @directory_sites = args[:directory_sites] if args.key?(:directory_sites) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Contains properties of a dynamic targeting key. Dynamic targeting keys are + # unique, user-friendly labels, created at the advertiser level in DCM, that can + # be assigned to ads, creatives, and placements and used for targeting with + # DoubleClick Studio dynamic creatives. Use these labels instead of numeric DCM + # IDs (such as placement IDs) to save time and avoid errors in your dynamic + # feeds. + class DynamicTargetingKey + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#dynamicTargetingKey". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this dynamic targeting key. This is a required field. Must be less + # than 256 characters long and cannot contain commas. All characters are + # converted to lowercase. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # ID of the object of this dynamic targeting key. This is a required field. + # Corresponds to the JSON property `objectId` + # @return [Fixnum] + attr_accessor :object_id_prop + + # Type of the object of this dynamic targeting key. This is a required field. + # Corresponds to the JSON property `objectType` + # @return [String] + attr_accessor :object_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) + @object_type = args[:object_type] if args.key?(:object_type) + end + end + + # Dynamic Targeting Key List Response + class DynamicTargetingKeysListResponse + include Google::Apis::Core::Hashable + + # Dynamic targeting key collection. + # Corresponds to the JSON property `dynamicTargetingKeys` + # @return [Array] + attr_accessor :dynamic_targeting_keys + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#dynamicTargetingKeysListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dynamic_targeting_keys = args[:dynamic_targeting_keys] if args.key?(:dynamic_targeting_keys) + @kind = args[:kind] if args.key?(:kind) + end + end + + # A description of how user IDs are encrypted. + class EncryptionInfo + include Google::Apis::Core::Hashable + + # The encryption entity ID. This should match the encryption configuration for + # ad serving or Data Transfer. + # Corresponds to the JSON property `encryptionEntityId` + # @return [Fixnum] + attr_accessor :encryption_entity_id + + # The encryption entity type. This should match the encryption configuration for + # ad serving or Data Transfer. + # Corresponds to the JSON property `encryptionEntityType` + # @return [String] + attr_accessor :encryption_entity_type + + # Describes whether the encrypted cookie was received from ad serving (the %m + # macro) or from Data Transfer. + # Corresponds to the JSON property `encryptionSource` + # @return [String] + attr_accessor :encryption_source + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#encryptionInfo". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @encryption_entity_id = args[:encryption_entity_id] if args.key?(:encryption_entity_id) + @encryption_entity_type = args[:encryption_entity_type] if args.key?(:encryption_entity_type) + @encryption_source = args[:encryption_source] if args.key?(:encryption_source) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Contains properties of an event tag. + class EventTag + include Google::Apis::Core::Hashable + + # Account ID of this event tag. This is a read-only field that can be left blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this event tag. This field or the campaignId field is + # required on insertion. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Campaign ID of this event tag. This field or the advertiserId field is + # required on insertion. + # Corresponds to the JSON property `campaignId` + # @return [Fixnum] + attr_accessor :campaign_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `campaignIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :campaign_id_dimension_value + + # Whether this event tag should be automatically enabled for all of the + # advertiser's campaigns and ads. + # Corresponds to the JSON property `enabledByDefault` + # @return [Boolean] + attr_accessor :enabled_by_default + alias_method :enabled_by_default?, :enabled_by_default + + # Whether to remove this event tag from ads that are trafficked through + # DoubleClick Bid Manager to Ad Exchange. This may be useful if the event tag + # uses a pixel that is unapproved for Ad Exchange bids on one or more networks, + # such as the Google Display Network. + # Corresponds to the JSON property `excludeFromAdxRequests` + # @return [Boolean] + attr_accessor :exclude_from_adx_requests + alias_method :exclude_from_adx_requests?, :exclude_from_adx_requests + + # ID of this event tag. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#eventTag". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this event tag. This is a required field and must be less than 256 + # characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Site filter type for this event tag. If no type is specified then the event + # tag will be applied to all sites. + # Corresponds to the JSON property `siteFilterType` + # @return [String] + attr_accessor :site_filter_type + + # Filter list of site IDs associated with this event tag. The siteFilterType + # determines whether this is a whitelist or blacklist filter. + # Corresponds to the JSON property `siteIds` + # @return [Array] + attr_accessor :site_ids + + # Whether this tag is SSL-compliant or not. This is a read-only field. + # Corresponds to the JSON property `sslCompliant` + # @return [Boolean] + attr_accessor :ssl_compliant + alias_method :ssl_compliant?, :ssl_compliant + + # Status of this event tag. Must be ENABLED for this event tag to fire. This is + # a required field. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # Subaccount ID of this event tag. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Event tag type. Can be used to specify whether to use a third-party pixel, a + # third-party JavaScript URL, or a third-party click-through URL for either + # impression or click tracking. This is a required field. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # Payload URL for this event tag. The URL on a click-through event tag should + # have a landing page URL appended to the end of it. This field is required on + # insertion. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + # Number of times the landing page URL should be URL-escaped before being + # appended to the click-through event tag URL. Only applies to click-through + # event tags as specified by the event tag type. + # Corresponds to the JSON property `urlEscapeLevels` + # @return [Fixnum] + attr_accessor :url_escape_levels + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @campaign_id = args[:campaign_id] if args.key?(:campaign_id) + @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) + @enabled_by_default = args[:enabled_by_default] if args.key?(:enabled_by_default) + @exclude_from_adx_requests = args[:exclude_from_adx_requests] if args.key?(:exclude_from_adx_requests) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @site_filter_type = args[:site_filter_type] if args.key?(:site_filter_type) + @site_ids = args[:site_ids] if args.key?(:site_ids) + @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) + @status = args[:status] if args.key?(:status) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @type = args[:type] if args.key?(:type) + @url = args[:url] if args.key?(:url) + @url_escape_levels = args[:url_escape_levels] if args.key?(:url_escape_levels) + end + end + + # Event tag override information. + class EventTagOverride + include Google::Apis::Core::Hashable + + # Whether this override is enabled. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + # ID of this event tag override. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enabled = args[:enabled] if args.key?(:enabled) + @id = args[:id] if args.key?(:id) + end + end + + # Event Tag List Response + class EventTagsListResponse + include Google::Apis::Core::Hashable + + # Event tag collection. + # Corresponds to the JSON property `eventTags` + # @return [Array] + attr_accessor :event_tags + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#eventTagsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @event_tags = args[:event_tags] if args.key?(:event_tags) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Represents a File resource. A file contains the metadata for a report run. It + # shows the status of the run and holds the URLs to the generated report data if + # the run is finished and the status is "REPORT_AVAILABLE". + class File + include Google::Apis::Core::Hashable + + # Represents a date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DfareportingV3_0::DateRange] + attr_accessor :date_range + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The filename of the file. + # Corresponds to the JSON property `fileName` + # @return [String] + attr_accessor :file_name + + # The output format of the report. Only available once the file is available. + # Corresponds to the JSON property `format` + # @return [String] + attr_accessor :format + + # The unique ID of this report file. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # The kind of resource this is, in this case dfareporting#file. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The timestamp in milliseconds since epoch when this file was last modified. + # Corresponds to the JSON property `lastModifiedTime` + # @return [Fixnum] + attr_accessor :last_modified_time + + # The ID of the report this file was generated from. + # Corresponds to the JSON property `reportId` + # @return [Fixnum] + attr_accessor :report_id + + # The status of the report file. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # The URLs where the completed report file can be downloaded. + # Corresponds to the JSON property `urls` + # @return [Google::Apis::DfareportingV3_0::File::Urls] + attr_accessor :urls + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @date_range = args[:date_range] if args.key?(:date_range) + @etag = args[:etag] if args.key?(:etag) + @file_name = args[:file_name] if args.key?(:file_name) + @format = args[:format] if args.key?(:format) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time) + @report_id = args[:report_id] if args.key?(:report_id) + @status = args[:status] if args.key?(:status) + @urls = args[:urls] if args.key?(:urls) + end + + # The URLs where the completed report file can be downloaded. + class Urls + include Google::Apis::Core::Hashable + + # The URL for downloading the report data through the API. + # Corresponds to the JSON property `apiUrl` + # @return [String] + attr_accessor :api_url + + # The URL for downloading the report data through a browser. + # Corresponds to the JSON property `browserUrl` + # @return [String] + attr_accessor :browser_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_url = args[:api_url] if args.key?(:api_url) + @browser_url = args[:browser_url] if args.key?(:browser_url) + end + end + end + + # Represents the list of File resources. + class FileList + include Google::Apis::Core::Hashable + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The files returned in this response. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # The kind of list this is, in this case dfareporting#fileList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Continuation token used to page through files. To retrieve the next page of + # results, set the next request's "pageToken" to the value of this field. The + # page token is only valid for a limited amount of time and should not be + # persisted. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Flight + class Flight + include Google::Apis::Core::Hashable + + # Inventory item flight end date. + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # Rate or cost of this flight. + # Corresponds to the JSON property `rateOrCost` + # @return [Fixnum] + attr_accessor :rate_or_cost + + # Inventory item flight start date. + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + # Units of this flight. + # Corresponds to the JSON property `units` + # @return [Fixnum] + attr_accessor :units + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_date = args[:end_date] if args.key?(:end_date) + @rate_or_cost = args[:rate_or_cost] if args.key?(:rate_or_cost) + @start_date = args[:start_date] if args.key?(:start_date) + @units = args[:units] if args.key?(:units) + end + end + + # Floodlight Activity GenerateTag Response + class FloodlightActivitiesGenerateTagResponse + include Google::Apis::Core::Hashable + + # Generated tag for this Floodlight activity. For global site tags, this is the + # event snippet. + # Corresponds to the JSON property `floodlightActivityTag` + # @return [String] + attr_accessor :floodlight_activity_tag + + # The global snippet section of a global site tag. The global site tag sets new + # cookies on your domain, which will store a unique identifier for a user or the + # ad click that brought the user to your site. Learn more. + # Corresponds to the JSON property `globalSiteTagGlobalSnippet` + # @return [String] + attr_accessor :global_site_tag_global_snippet + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#floodlightActivitiesGenerateTagResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @floodlight_activity_tag = args[:floodlight_activity_tag] if args.key?(:floodlight_activity_tag) + @global_site_tag_global_snippet = args[:global_site_tag_global_snippet] if args.key?(:global_site_tag_global_snippet) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Floodlight Activity List Response + class FloodlightActivitiesListResponse + include Google::Apis::Core::Hashable + + # Floodlight activity collection. + # Corresponds to the JSON property `floodlightActivities` + # @return [Array] + attr_accessor :floodlight_activities + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#floodlightActivitiesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @floodlight_activities = args[:floodlight_activities] if args.key?(:floodlight_activities) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Contains properties of a Floodlight activity. + class FloodlightActivity + include Google::Apis::Core::Hashable + + # Account ID of this floodlight activity. This is a read-only field that can be + # left blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this floodlight activity. If this field is left blank, the + # value will be copied over either from the activity group's advertiser or the + # existing activity's advertiser. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Code type used for cache busting in the generated tag. Applicable only when + # floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING + # or UNIQUE_COUNTING. + # Corresponds to the JSON property `cacheBustingType` + # @return [String] + attr_accessor :cache_busting_type + + # Counting method for conversions for this floodlight activity. This is a + # required field. + # Corresponds to the JSON property `countingMethod` + # @return [String] + attr_accessor :counting_method + + # Dynamic floodlight tags. + # Corresponds to the JSON property `defaultTags` + # @return [Array] + attr_accessor :default_tags + + # URL where this tag will be deployed. If specified, must be less than 256 + # characters long. + # Corresponds to the JSON property `expectedUrl` + # @return [String] + attr_accessor :expected_url + + # Floodlight activity group ID of this floodlight activity. This is a required + # field. + # Corresponds to the JSON property `floodlightActivityGroupId` + # @return [Fixnum] + attr_accessor :floodlight_activity_group_id + + # Name of the associated floodlight activity group. This is a read-only field. + # Corresponds to the JSON property `floodlightActivityGroupName` + # @return [String] + attr_accessor :floodlight_activity_group_name + + # Tag string of the associated floodlight activity group. This is a read-only + # field. + # Corresponds to the JSON property `floodlightActivityGroupTagString` + # @return [String] + attr_accessor :floodlight_activity_group_tag_string + + # Type of the associated floodlight activity group. This is a read-only field. + # Corresponds to the JSON property `floodlightActivityGroupType` + # @return [String] + attr_accessor :floodlight_activity_group_type + + # Floodlight configuration ID of this floodlight activity. If this field is left + # blank, the value will be copied over either from the activity group's + # floodlight configuration or from the existing activity's floodlight + # configuration. + # Corresponds to the JSON property `floodlightConfigurationId` + # @return [Fixnum] + attr_accessor :floodlight_configuration_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :floodlight_configuration_id_dimension_value + + # The type of Floodlight tag this activity will generate. This is a required + # field. + # Corresponds to the JSON property `floodlightTagType` + # @return [String] + attr_accessor :floodlight_tag_type + + # Whether this activity is archived. + # Corresponds to the JSON property `hidden` + # @return [Boolean] + attr_accessor :hidden + alias_method :hidden?, :hidden + + # ID of this floodlight activity. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :id_dimension_value + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#floodlightActivity". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this floodlight activity. This is a required field. Must be less than + # 129 characters long and cannot contain quotes. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # General notes or implementation instructions for the tag. + # Corresponds to the JSON property `notes` + # @return [String] + attr_accessor :notes + + # Publisher dynamic floodlight tags. + # Corresponds to the JSON property `publisherTags` + # @return [Array] + attr_accessor :publisher_tags + + # Whether this tag should use SSL. + # Corresponds to the JSON property `secure` + # @return [Boolean] + attr_accessor :secure + alias_method :secure?, :secure + + # Whether the floodlight activity is SSL-compliant. This is a read-only field, + # its value detected by the system from the floodlight tags. + # Corresponds to the JSON property `sslCompliant` + # @return [Boolean] + attr_accessor :ssl_compliant + alias_method :ssl_compliant?, :ssl_compliant + + # Whether this floodlight activity must be SSL-compliant. + # Corresponds to the JSON property `sslRequired` + # @return [Boolean] + attr_accessor :ssl_required + alias_method :ssl_required?, :ssl_required + + # Subaccount ID of this floodlight activity. This is a read-only field that can + # be left blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Tag format type for the floodlight activity. If left blank, the tag format + # will default to HTML. + # Corresponds to the JSON property `tagFormat` + # @return [String] + attr_accessor :tag_format + + # Value of the cat= parameter in the floodlight tag, which the ad servers use to + # identify the activity. This is optional: if empty, a new tag string will be + # generated for you. This string must be 1 to 8 characters long, with valid + # characters being [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique + # among activities of the same activity group. This field is read-only after + # insertion. + # Corresponds to the JSON property `tagString` + # @return [String] + attr_accessor :tag_string + + # List of the user-defined variables used by this conversion tag. These map to + # the "u[1-100]=" in the tags. Each of these can have a user defined type. + # Acceptable values are U1 to U100, inclusive. + # Corresponds to the JSON property `userDefinedVariableTypes` + # @return [Array] + attr_accessor :user_defined_variable_types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @cache_busting_type = args[:cache_busting_type] if args.key?(:cache_busting_type) + @counting_method = args[:counting_method] if args.key?(:counting_method) + @default_tags = args[:default_tags] if args.key?(:default_tags) + @expected_url = args[:expected_url] if args.key?(:expected_url) + @floodlight_activity_group_id = args[:floodlight_activity_group_id] if args.key?(:floodlight_activity_group_id) + @floodlight_activity_group_name = args[:floodlight_activity_group_name] if args.key?(:floodlight_activity_group_name) + @floodlight_activity_group_tag_string = args[:floodlight_activity_group_tag_string] if args.key?(:floodlight_activity_group_tag_string) + @floodlight_activity_group_type = args[:floodlight_activity_group_type] if args.key?(:floodlight_activity_group_type) + @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) + @floodlight_configuration_id_dimension_value = args[:floodlight_configuration_id_dimension_value] if args.key?(:floodlight_configuration_id_dimension_value) + @floodlight_tag_type = args[:floodlight_tag_type] if args.key?(:floodlight_tag_type) + @hidden = args[:hidden] if args.key?(:hidden) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @notes = args[:notes] if args.key?(:notes) + @publisher_tags = args[:publisher_tags] if args.key?(:publisher_tags) + @secure = args[:secure] if args.key?(:secure) + @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant) + @ssl_required = args[:ssl_required] if args.key?(:ssl_required) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @tag_format = args[:tag_format] if args.key?(:tag_format) + @tag_string = args[:tag_string] if args.key?(:tag_string) + @user_defined_variable_types = args[:user_defined_variable_types] if args.key?(:user_defined_variable_types) + end + end + + # Dynamic Tag + class FloodlightActivityDynamicTag + include Google::Apis::Core::Hashable + + # ID of this dynamic tag. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Name of this tag. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Tag code. + # Corresponds to the JSON property `tag` + # @return [String] + attr_accessor :tag + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @name = args[:name] if args.key?(:name) + @tag = args[:tag] if args.key?(:tag) + end + end + + # Contains properties of a Floodlight activity group. + class FloodlightActivityGroup + include Google::Apis::Core::Hashable + + # Account ID of this floodlight activity group. This is a read-only field that + # can be left blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this floodlight activity group. If this field is left blank, + # the value will be copied over either from the floodlight configuration's + # advertiser or from the existing activity group's advertiser. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Floodlight configuration ID of this floodlight activity group. This is a + # required field. + # Corresponds to the JSON property `floodlightConfigurationId` + # @return [Fixnum] + attr_accessor :floodlight_configuration_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightConfigurationIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :floodlight_configuration_id_dimension_value + + # ID of this floodlight activity group. This is a read-only, auto-generated + # field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :id_dimension_value + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#floodlightActivityGroup". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this floodlight activity group. This is a required field. Must be less + # than 65 characters long and cannot contain quotes. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Subaccount ID of this floodlight activity group. This is a read-only field + # that can be left blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Value of the type= parameter in the floodlight tag, which the ad servers use + # to identify the activity group that the activity belongs to. This is optional: + # if empty, a new tag string will be generated for you. This string must be 1 to + # 8 characters long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This + # tag string must also be unique among activity groups of the same floodlight + # configuration. This field is read-only after insertion. + # Corresponds to the JSON property `tagString` + # @return [String] + attr_accessor :tag_string + + # Type of the floodlight activity group. This is a required field that is read- + # only after insertion. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id) + @floodlight_configuration_id_dimension_value = args[:floodlight_configuration_id_dimension_value] if args.key?(:floodlight_configuration_id_dimension_value) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @tag_string = args[:tag_string] if args.key?(:tag_string) + @type = args[:type] if args.key?(:type) + end + end + + # Floodlight Activity Group List Response + class FloodlightActivityGroupsListResponse + include Google::Apis::Core::Hashable + + # Floodlight activity group collection. + # Corresponds to the JSON property `floodlightActivityGroups` + # @return [Array] + attr_accessor :floodlight_activity_groups + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#floodlightActivityGroupsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @floodlight_activity_groups = args[:floodlight_activity_groups] if args.key?(:floodlight_activity_groups) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Publisher Dynamic Tag + class FloodlightActivityPublisherDynamicTag + include Google::Apis::Core::Hashable + + # Whether this tag is applicable only for click-throughs. + # Corresponds to the JSON property `clickThrough` + # @return [Boolean] + attr_accessor :click_through + alias_method :click_through?, :click_through + + # Directory site ID of this dynamic tag. This is a write-only field that can be + # used as an alternative to the siteId field. When this resource is retrieved, + # only the siteId field will be populated. + # Corresponds to the JSON property `directorySiteId` + # @return [Fixnum] + attr_accessor :directory_site_id + + # Dynamic Tag + # Corresponds to the JSON property `dynamicTag` + # @return [Google::Apis::DfareportingV3_0::FloodlightActivityDynamicTag] + attr_accessor :dynamic_tag + + # Site ID of this dynamic tag. + # Corresponds to the JSON property `siteId` + # @return [Fixnum] + attr_accessor :site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `siteIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :site_id_dimension_value + + # Whether this tag is applicable only for view-throughs. + # Corresponds to the JSON property `viewThrough` + # @return [Boolean] + attr_accessor :view_through + alias_method :view_through?, :view_through + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @click_through = args[:click_through] if args.key?(:click_through) + @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) + @dynamic_tag = args[:dynamic_tag] if args.key?(:dynamic_tag) + @site_id = args[:site_id] if args.key?(:site_id) + @site_id_dimension_value = args[:site_id_dimension_value] if args.key?(:site_id_dimension_value) + @view_through = args[:view_through] if args.key?(:view_through) + end + end + + # Contains properties of a Floodlight configuration. + class FloodlightConfiguration + include Google::Apis::Core::Hashable + + # Account ID of this floodlight configuration. This is a read-only field that + # can be left blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Advertiser ID of the parent advertiser of this floodlight configuration. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Whether advertiser data is shared with Google Analytics. + # Corresponds to the JSON property `analyticsDataSharingEnabled` + # @return [Boolean] + attr_accessor :analytics_data_sharing_enabled + alias_method :analytics_data_sharing_enabled?, :analytics_data_sharing_enabled + + # Whether the exposure-to-conversion report is enabled. This report shows + # detailed pathway information on up to 10 of the most recent ad exposures seen + # by a user before converting. + # Corresponds to the JSON property `exposureToConversionEnabled` + # @return [Boolean] + attr_accessor :exposure_to_conversion_enabled + alias_method :exposure_to_conversion_enabled?, :exposure_to_conversion_enabled + + # Day that will be counted as the first day of the week in reports. This is a + # required field. + # Corresponds to the JSON property `firstDayOfWeek` + # @return [String] + attr_accessor :first_day_of_week + + # ID of this floodlight configuration. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :id_dimension_value + + # Whether in-app attribution tracking is enabled. + # Corresponds to the JSON property `inAppAttributionTrackingEnabled` + # @return [Boolean] + attr_accessor :in_app_attribution_tracking_enabled + alias_method :in_app_attribution_tracking_enabled?, :in_app_attribution_tracking_enabled + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#floodlightConfiguration". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Lookback configuration settings. + # Corresponds to the JSON property `lookbackConfiguration` + # @return [Google::Apis::DfareportingV3_0::LookbackConfiguration] + attr_accessor :lookback_configuration + + # Types of attribution options for natural search conversions. + # Corresponds to the JSON property `naturalSearchConversionAttributionOption` + # @return [String] + attr_accessor :natural_search_conversion_attribution_option + + # Omniture Integration Settings. + # Corresponds to the JSON property `omnitureSettings` + # @return [Google::Apis::DfareportingV3_0::OmnitureSettings] + attr_accessor :omniture_settings + + # Subaccount ID of this floodlight configuration. This is a read-only field that + # can be left blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Dynamic and Image Tag Settings. + # Corresponds to the JSON property `tagSettings` + # @return [Google::Apis::DfareportingV3_0::TagSettings] + attr_accessor :tag_settings + + # List of third-party authentication tokens enabled for this configuration. + # Corresponds to the JSON property `thirdPartyAuthenticationTokens` + # @return [Array] + attr_accessor :third_party_authentication_tokens + + # List of user defined variables enabled for this configuration. + # Corresponds to the JSON property `userDefinedVariableConfigurations` + # @return [Array] + attr_accessor :user_defined_variable_configurations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @analytics_data_sharing_enabled = args[:analytics_data_sharing_enabled] if args.key?(:analytics_data_sharing_enabled) + @exposure_to_conversion_enabled = args[:exposure_to_conversion_enabled] if args.key?(:exposure_to_conversion_enabled) + @first_day_of_week = args[:first_day_of_week] if args.key?(:first_day_of_week) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @in_app_attribution_tracking_enabled = args[:in_app_attribution_tracking_enabled] if args.key?(:in_app_attribution_tracking_enabled) + @kind = args[:kind] if args.key?(:kind) + @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) + @natural_search_conversion_attribution_option = args[:natural_search_conversion_attribution_option] if args.key?(:natural_search_conversion_attribution_option) + @omniture_settings = args[:omniture_settings] if args.key?(:omniture_settings) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @tag_settings = args[:tag_settings] if args.key?(:tag_settings) + @third_party_authentication_tokens = args[:third_party_authentication_tokens] if args.key?(:third_party_authentication_tokens) + @user_defined_variable_configurations = args[:user_defined_variable_configurations] if args.key?(:user_defined_variable_configurations) + end + end + + # Floodlight Configuration List Response + class FloodlightConfigurationsListResponse + include Google::Apis::Core::Hashable + + # Floodlight configuration collection. + # Corresponds to the JSON property `floodlightConfigurations` + # @return [Array] + attr_accessor :floodlight_configurations + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#floodlightConfigurationsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @floodlight_configurations = args[:floodlight_configurations] if args.key?(:floodlight_configurations) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Represents fields that are compatible to be selected for a report of type " + # FlOODLIGHT". + class FloodlightReportCompatibleFields + include Google::Apis::Core::Hashable + + # Dimensions which are compatible to be selected in the "dimensionFilters" + # section of the report. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # Dimensions which are compatible to be selected in the "dimensions" section of + # the report. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # The kind of resource this is, in this case dfareporting# + # floodlightReportCompatibleFields. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metrics which are compatible to be selected in the "metricNames" section of + # the report. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @kind = args[:kind] if args.key?(:kind) + @metrics = args[:metrics] if args.key?(:metrics) + end + end + + # Frequency Cap. + class FrequencyCap + include Google::Apis::Core::Hashable + + # Duration of time, in seconds, for this frequency cap. The maximum duration is + # 90 days. Acceptable values are 1 to 7776000, inclusive. + # Corresponds to the JSON property `duration` + # @return [Fixnum] + attr_accessor :duration + + # Number of times an individual user can be served the ad within the specified + # duration. Acceptable values are 1 to 15, inclusive. + # Corresponds to the JSON property `impressions` + # @return [Fixnum] + attr_accessor :impressions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @duration = args[:duration] if args.key?(:duration) + @impressions = args[:impressions] if args.key?(:impressions) + end + end + + # FsCommand. + class FsCommand + include Google::Apis::Core::Hashable + + # Distance from the left of the browser.Applicable when positionOption is + # DISTANCE_FROM_TOP_LEFT_CORNER. + # Corresponds to the JSON property `left` + # @return [Fixnum] + attr_accessor :left + + # Position in the browser where the window will open. + # Corresponds to the JSON property `positionOption` + # @return [String] + attr_accessor :position_option + + # Distance from the top of the browser. Applicable when positionOption is + # DISTANCE_FROM_TOP_LEFT_CORNER. + # Corresponds to the JSON property `top` + # @return [Fixnum] + attr_accessor :top + + # Height of the window. + # Corresponds to the JSON property `windowHeight` + # @return [Fixnum] + attr_accessor :window_height + + # Width of the window. + # Corresponds to the JSON property `windowWidth` + # @return [Fixnum] + attr_accessor :window_width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @left = args[:left] if args.key?(:left) + @position_option = args[:position_option] if args.key?(:position_option) + @top = args[:top] if args.key?(:top) + @window_height = args[:window_height] if args.key?(:window_height) + @window_width = args[:window_width] if args.key?(:window_width) + end + end + + # Geographical Targeting. + class GeoTargeting + include Google::Apis::Core::Hashable + + # Cities to be targeted. For each city only dartId is required. The other fields + # are populated automatically when the ad is inserted or updated. If targeting a + # city, do not target or exclude the country of the city, and do not target the + # metro or region of the city. + # Corresponds to the JSON property `cities` + # @return [Array] + attr_accessor :cities + + # Countries to be targeted or excluded from targeting, depending on the setting + # of the excludeCountries field. For each country only dartId is required. The + # other fields are populated automatically when the ad is inserted or updated. + # If targeting or excluding a country, do not target regions, cities, metros, or + # postal codes in the same country. + # Corresponds to the JSON property `countries` + # @return [Array] + attr_accessor :countries + + # Whether or not to exclude the countries in the countries field from targeting. + # If false, the countries field refers to countries which will be targeted by + # the ad. + # Corresponds to the JSON property `excludeCountries` + # @return [Boolean] + attr_accessor :exclude_countries + alias_method :exclude_countries?, :exclude_countries + + # Metros to be targeted. For each metro only dmaId is required. The other fields + # are populated automatically when the ad is inserted or updated. If targeting a + # metro, do not target or exclude the country of the metro. + # Corresponds to the JSON property `metros` + # @return [Array] + attr_accessor :metros + + # Postal codes to be targeted. For each postal code only id is required. The + # other fields are populated automatically when the ad is inserted or updated. + # If targeting a postal code, do not target or exclude the country of the postal + # code. + # Corresponds to the JSON property `postalCodes` + # @return [Array] + attr_accessor :postal_codes + + # Regions to be targeted. For each region only dartId is required. The other + # fields are populated automatically when the ad is inserted or updated. If + # targeting a region, do not target or exclude the country of the region. + # Corresponds to the JSON property `regions` + # @return [Array] + attr_accessor :regions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cities = args[:cities] if args.key?(:cities) + @countries = args[:countries] if args.key?(:countries) + @exclude_countries = args[:exclude_countries] if args.key?(:exclude_countries) + @metros = args[:metros] if args.key?(:metros) + @postal_codes = args[:postal_codes] if args.key?(:postal_codes) + @regions = args[:regions] if args.key?(:regions) + end + end + + # Represents a buy from the DoubleClick Planning inventory store. + class InventoryItem + include Google::Apis::Core::Hashable + + # Account ID of this inventory item. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Ad slots of this inventory item. If this inventory item represents a + # standalone placement, there will be exactly one ad slot. If this inventory + # item represents a placement group, there will be more than one ad slot, each + # representing one child placement in that placement group. + # Corresponds to the JSON property `adSlots` + # @return [Array] + attr_accessor :ad_slots + + # Advertiser ID of this inventory item. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Content category ID of this inventory item. + # Corresponds to the JSON property `contentCategoryId` + # @return [Fixnum] + attr_accessor :content_category_id + + # Estimated click-through rate of this inventory item. + # Corresponds to the JSON property `estimatedClickThroughRate` + # @return [Fixnum] + attr_accessor :estimated_click_through_rate + + # Estimated conversion rate of this inventory item. + # Corresponds to the JSON property `estimatedConversionRate` + # @return [Fixnum] + attr_accessor :estimated_conversion_rate + + # ID of this inventory item. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Whether this inventory item is in plan. + # Corresponds to the JSON property `inPlan` + # @return [Boolean] + attr_accessor :in_plan + alias_method :in_plan?, :in_plan + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#inventoryItem". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] + attr_accessor :last_modified_info + + # Name of this inventory item. For standalone inventory items, this is the same + # name as that of its only ad slot. For group inventory items, this can differ + # from the name of any of its ad slots. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Negotiation channel ID of this inventory item. + # Corresponds to the JSON property `negotiationChannelId` + # @return [Fixnum] + attr_accessor :negotiation_channel_id + + # Order ID of this inventory item. + # Corresponds to the JSON property `orderId` + # @return [Fixnum] + attr_accessor :order_id + + # Placement strategy ID of this inventory item. + # Corresponds to the JSON property `placementStrategyId` + # @return [Fixnum] + attr_accessor :placement_strategy_id + + # Pricing Information + # Corresponds to the JSON property `pricing` + # @return [Google::Apis::DfareportingV3_0::Pricing] + attr_accessor :pricing + + # Project ID of this inventory item. + # Corresponds to the JSON property `projectId` + # @return [Fixnum] + attr_accessor :project_id + + # RFP ID of this inventory item. + # Corresponds to the JSON property `rfpId` + # @return [Fixnum] + attr_accessor :rfp_id + + # ID of the site this inventory item is associated with. + # Corresponds to the JSON property `siteId` + # @return [Fixnum] + attr_accessor :site_id + + # Subaccount ID of this inventory item. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Type of inventory item. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @ad_slots = args[:ad_slots] if args.key?(:ad_slots) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @content_category_id = args[:content_category_id] if args.key?(:content_category_id) + @estimated_click_through_rate = args[:estimated_click_through_rate] if args.key?(:estimated_click_through_rate) + @estimated_conversion_rate = args[:estimated_conversion_rate] if args.key?(:estimated_conversion_rate) + @id = args[:id] if args.key?(:id) + @in_plan = args[:in_plan] if args.key?(:in_plan) + @kind = args[:kind] if args.key?(:kind) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @name = args[:name] if args.key?(:name) + @negotiation_channel_id = args[:negotiation_channel_id] if args.key?(:negotiation_channel_id) + @order_id = args[:order_id] if args.key?(:order_id) + @placement_strategy_id = args[:placement_strategy_id] if args.key?(:placement_strategy_id) + @pricing = args[:pricing] if args.key?(:pricing) + @project_id = args[:project_id] if args.key?(:project_id) + @rfp_id = args[:rfp_id] if args.key?(:rfp_id) + @site_id = args[:site_id] if args.key?(:site_id) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @type = args[:type] if args.key?(:type) + end + end + + # Inventory item List Response + class InventoryItemsListResponse + include Google::Apis::Core::Hashable + + # Inventory item collection + # Corresponds to the JSON property `inventoryItems` + # @return [Array] + attr_accessor :inventory_items + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#inventoryItemsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @inventory_items = args[:inventory_items] if args.key?(:inventory_items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Key Value Targeting Expression. + class KeyValueTargetingExpression + include Google::Apis::Core::Hashable + + # Keyword expression being targeted by the ad. + # Corresponds to the JSON property `expression` + # @return [String] + attr_accessor :expression + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @expression = args[:expression] if args.key?(:expression) + end + end + + # Contains information about where a user's browser is taken after the user + # clicks an ad. + class LandingPage + include Google::Apis::Core::Hashable + + # Advertiser ID of this landing page. This is a required field. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Whether this landing page has been archived. + # Corresponds to the JSON property `archived` + # @return [Boolean] + attr_accessor :archived + alias_method :archived?, :archived + + # ID of this landing page. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#landingPage". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this landing page. This is a required field. It must be less than 256 + # characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # URL of this landing page. This is a required field. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @archived = args[:archived] if args.key?(:archived) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @url = args[:url] if args.key?(:url) + end + end + + # Contains information about a language that can be targeted by ads. + class Language + include Google::Apis::Core::Hashable + + # Language ID of this language. This is the ID used for targeting and generating + # reports. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#language". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Format of language code is an ISO 639 two-letter language code optionally + # followed by an underscore followed by an ISO 3166 code. Examples are "en" for + # English or "zh_CN" for Simplified Chinese. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Name of this language. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @language_code = args[:language_code] if args.key?(:language_code) + @name = args[:name] if args.key?(:name) + end + end + + # Language Targeting. + class LanguageTargeting + include Google::Apis::Core::Hashable + + # Languages that this ad targets. For each language only languageId is required. + # The other fields are populated automatically when the ad is inserted or + # updated. + # Corresponds to the JSON property `languages` + # @return [Array] + attr_accessor :languages + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @languages = args[:languages] if args.key?(:languages) + end + end + + # Language List Response + class LanguagesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#languagesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Language collection. + # Corresponds to the JSON property `languages` + # @return [Array] + attr_accessor :languages + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @languages = args[:languages] if args.key?(:languages) + end + end + + # Modification timestamp. + class LastModifiedInfo + include Google::Apis::Core::Hashable + + # Timestamp of the last change in milliseconds since epoch. + # Corresponds to the JSON property `time` + # @return [Fixnum] + attr_accessor :time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @time = args[:time] if args.key?(:time) + end + end + + # A group clause made up of list population terms representing constraints + # joined by ORs. + class ListPopulationClause + include Google::Apis::Core::Hashable + + # Terms of this list population clause. Each clause is made up of list + # population terms representing constraints and are joined by ORs. + # Corresponds to the JSON property `terms` + # @return [Array] + attr_accessor :terms + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @terms = args[:terms] if args.key?(:terms) + end + end + + # Remarketing List Population Rule. + class ListPopulationRule + include Google::Apis::Core::Hashable + + # Floodlight activity ID associated with this rule. This field can be left blank. + # Corresponds to the JSON property `floodlightActivityId` + # @return [Fixnum] + attr_accessor :floodlight_activity_id + + # Name of floodlight activity associated with this rule. This is a read-only, + # auto-generated field. + # Corresponds to the JSON property `floodlightActivityName` + # @return [String] + attr_accessor :floodlight_activity_name + + # Clauses that make up this list population rule. Clauses are joined by ANDs, + # and the clauses themselves are made up of list population terms which are + # joined by ORs. + # Corresponds to the JSON property `listPopulationClauses` + # @return [Array] + attr_accessor :list_population_clauses + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id) + @floodlight_activity_name = args[:floodlight_activity_name] if args.key?(:floodlight_activity_name) + @list_population_clauses = args[:list_population_clauses] if args.key?(:list_population_clauses) + end + end + + # Remarketing List Population Rule Term. + class ListPopulationTerm + include Google::Apis::Core::Hashable + + # Will be true if the term should check if the user is in the list and false if + # the term should check if the user is not in the list. This field is only + # relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. + # Corresponds to the JSON property `contains` + # @return [Boolean] + attr_accessor :contains + alias_method :contains?, :contains + + # Whether to negate the comparison result of this term during rule evaluation. + # This field is only relevant when type is left unset or set to + # CUSTOM_VARIABLE_TERM or REFERRER_TERM. + # Corresponds to the JSON property `negation` + # @return [Boolean] + attr_accessor :negation + alias_method :negation?, :negation + + # Comparison operator of this term. This field is only relevant when type is + # left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + # Corresponds to the JSON property `operator` + # @return [String] + attr_accessor :operator + + # ID of the list in question. This field is only relevant when type is set to + # LIST_MEMBERSHIP_TERM. + # Corresponds to the JSON property `remarketingListId` + # @return [Fixnum] + attr_accessor :remarketing_list_id + + # List population term type determines the applicable fields in this object. If + # left unset or set to CUSTOM_VARIABLE_TERM, then variableName, + # variableFriendlyName, operator, value, and negation are applicable. If set to + # LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If + # set to REFERRER_TERM then operator, value, and negation are applicable. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # Literal to compare the variable to. This field is only relevant when type is + # left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + # Friendly name of this term's variable. This is a read-only, auto-generated + # field. This field is only relevant when type is left unset or set to + # CUSTOM_VARIABLE_TERM. + # Corresponds to the JSON property `variableFriendlyName` + # @return [String] + attr_accessor :variable_friendly_name + + # Name of the variable (U1, U2, etc.) being compared in this term. This field is + # only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. + # Corresponds to the JSON property `variableName` + # @return [String] + attr_accessor :variable_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @contains = args[:contains] if args.key?(:contains) + @negation = args[:negation] if args.key?(:negation) + @operator = args[:operator] if args.key?(:operator) + @remarketing_list_id = args[:remarketing_list_id] if args.key?(:remarketing_list_id) + @type = args[:type] if args.key?(:type) + @value = args[:value] if args.key?(:value) + @variable_friendly_name = args[:variable_friendly_name] if args.key?(:variable_friendly_name) + @variable_name = args[:variable_name] if args.key?(:variable_name) + end + end + + # Remarketing List Targeting Expression. + class ListTargetingExpression + include Google::Apis::Core::Hashable + + # Expression describing which lists are being targeted by the ad. + # Corresponds to the JSON property `expression` + # @return [String] + attr_accessor :expression + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @expression = args[:expression] if args.key?(:expression) + end + end + + # Lookback configuration settings. + class LookbackConfiguration + include Google::Apis::Core::Hashable + + # Lookback window, in days, from the last time a given user clicked on one of + # your ads. If you enter 0, clicks will not be considered as triggering events + # for floodlight tracking. If you leave this field blank, the default value for + # your account will be used. Acceptable values are 0 to 90, inclusive. + # Corresponds to the JSON property `clickDuration` + # @return [Fixnum] + attr_accessor :click_duration + + # Lookback window, in days, from the last time a given user viewed one of your + # ads. If you enter 0, impressions will not be considered as triggering events + # for floodlight tracking. If you leave this field blank, the default value for + # your account will be used. Acceptable values are 0 to 90, inclusive. + # Corresponds to the JSON property `postImpressionActivitiesDuration` + # @return [Fixnum] + attr_accessor :post_impression_activities_duration + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @click_duration = args[:click_duration] if args.key?(:click_duration) + @post_impression_activities_duration = args[:post_impression_activities_duration] if args.key?(:post_impression_activities_duration) + end + end + + # Represents a metric. + class Metric + include Google::Apis::Core::Hashable + + # The kind of resource this is, in this case dfareporting#metric. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The metric name, e.g. dfa:impressions + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Contains information about a metro region that can be targeted by ads. + class Metro + include Google::Apis::Core::Hashable + + # Country code of the country to which this metro region belongs. + # Corresponds to the JSON property `countryCode` + # @return [String] + attr_accessor :country_code + + # DART ID of the country to which this metro region belongs. + # Corresponds to the JSON property `countryDartId` + # @return [Fixnum] + attr_accessor :country_dart_id + + # DART ID of this metro region. + # Corresponds to the JSON property `dartId` + # @return [Fixnum] + attr_accessor :dart_id + + # DMA ID of this metro region. This is the ID used for targeting and generating + # reports, and is equivalent to metro_code. + # Corresponds to the JSON property `dmaId` + # @return [Fixnum] + attr_accessor :dma_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#metro". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metro code of this metro region. This is equivalent to dma_id. + # Corresponds to the JSON property `metroCode` + # @return [String] + attr_accessor :metro_code + + # Name of this metro region. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @country_code = args[:country_code] if args.key?(:country_code) + @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) + @dart_id = args[:dart_id] if args.key?(:dart_id) + @dma_id = args[:dma_id] if args.key?(:dma_id) + @kind = args[:kind] if args.key?(:kind) + @metro_code = args[:metro_code] if args.key?(:metro_code) + @name = args[:name] if args.key?(:name) + end + end + + # Metro List Response + class MetrosListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#metrosListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metro collection. + # Corresponds to the JSON property `metros` + # @return [Array] + attr_accessor :metros + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @metros = args[:metros] if args.key?(:metros) + end + end + + # Contains information about a mobile carrier that can be targeted by ads. + class MobileCarrier + include Google::Apis::Core::Hashable + + # Country code of the country to which this mobile carrier belongs. + # Corresponds to the JSON property `countryCode` + # @return [String] + attr_accessor :country_code + + # DART ID of the country to which this mobile carrier belongs. + # Corresponds to the JSON property `countryDartId` + # @return [Fixnum] + attr_accessor :country_dart_id + + # ID of this mobile carrier. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#mobileCarrier". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this mobile carrier. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @country_code = args[:country_code] if args.key?(:country_code) + @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Mobile Carrier List Response + class MobileCarriersListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#mobileCarriersListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Mobile carrier collection. + # Corresponds to the JSON property `mobileCarriers` + # @return [Array] + attr_accessor :mobile_carriers + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @mobile_carriers = args[:mobile_carriers] if args.key?(:mobile_carriers) + end + end + + # Object Filter. + class ObjectFilter + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#objectFilter". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Applicable when status is ASSIGNED. The user has access to objects with these + # object IDs. + # Corresponds to the JSON property `objectIds` + # @return [Array] + attr_accessor :object_ids + + # Status of the filter. NONE means the user has access to none of the objects. + # ALL means the user has access to all objects. ASSIGNED means the user has + # access to the objects with IDs in the objectIds list. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @object_ids = args[:object_ids] if args.key?(:object_ids) + @status = args[:status] if args.key?(:status) + end + end + + # Offset Position. + class OffsetPosition + include Google::Apis::Core::Hashable + + # Offset distance from left side of an asset or a window. + # Corresponds to the JSON property `left` + # @return [Fixnum] + attr_accessor :left + + # Offset distance from top side of an asset or a window. + # Corresponds to the JSON property `top` + # @return [Fixnum] + attr_accessor :top + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @left = args[:left] if args.key?(:left) + @top = args[:top] if args.key?(:top) + end + end + + # Omniture Integration Settings. + class OmnitureSettings + include Google::Apis::Core::Hashable + + # Whether placement cost data will be sent to Omniture. This property can be + # enabled only if omnitureIntegrationEnabled is true. + # Corresponds to the JSON property `omnitureCostDataEnabled` + # @return [Boolean] + attr_accessor :omniture_cost_data_enabled + alias_method :omniture_cost_data_enabled?, :omniture_cost_data_enabled + + # Whether Omniture integration is enabled. This property can be enabled only + # when the "Advanced Ad Serving" account setting is enabled. + # Corresponds to the JSON property `omnitureIntegrationEnabled` + # @return [Boolean] + attr_accessor :omniture_integration_enabled + alias_method :omniture_integration_enabled?, :omniture_integration_enabled + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @omniture_cost_data_enabled = args[:omniture_cost_data_enabled] if args.key?(:omniture_cost_data_enabled) + @omniture_integration_enabled = args[:omniture_integration_enabled] if args.key?(:omniture_integration_enabled) + end + end + + # Contains information about an operating system that can be targeted by ads. + class OperatingSystem + include Google::Apis::Core::Hashable + + # DART ID of this operating system. This is the ID used for targeting. + # Corresponds to the JSON property `dartId` + # @return [Fixnum] + attr_accessor :dart_id + + # Whether this operating system is for desktop. + # Corresponds to the JSON property `desktop` + # @return [Boolean] + attr_accessor :desktop + alias_method :desktop?, :desktop + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#operatingSystem". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Whether this operating system is for mobile. + # Corresponds to the JSON property `mobile` + # @return [Boolean] + attr_accessor :mobile + alias_method :mobile?, :mobile + + # Name of this operating system. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dart_id = args[:dart_id] if args.key?(:dart_id) + @desktop = args[:desktop] if args.key?(:desktop) + @kind = args[:kind] if args.key?(:kind) + @mobile = args[:mobile] if args.key?(:mobile) + @name = args[:name] if args.key?(:name) + end + end + + # Contains information about a particular version of an operating system that + # can be targeted by ads. + class OperatingSystemVersion + include Google::Apis::Core::Hashable + + # ID of this operating system version. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#operatingSystemVersion". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Major version (leftmost number) of this operating system version. + # Corresponds to the JSON property `majorVersion` + # @return [String] + attr_accessor :major_version + + # Minor version (number after the first dot) of this operating system version. + # Corresponds to the JSON property `minorVersion` + # @return [String] + attr_accessor :minor_version + + # Name of this operating system version. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Contains information about an operating system that can be targeted by ads. + # Corresponds to the JSON property `operatingSystem` + # @return [Google::Apis::DfareportingV3_0::OperatingSystem] + attr_accessor :operating_system + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @major_version = args[:major_version] if args.key?(:major_version) + @minor_version = args[:minor_version] if args.key?(:minor_version) + @name = args[:name] if args.key?(:name) + @operating_system = args[:operating_system] if args.key?(:operating_system) + end + end + + # Operating System Version List Response + class OperatingSystemVersionsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#operatingSystemVersionsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Operating system version collection. + # Corresponds to the JSON property `operatingSystemVersions` + # @return [Array] + attr_accessor :operating_system_versions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @operating_system_versions = args[:operating_system_versions] if args.key?(:operating_system_versions) + end + end + + # Operating System List Response + class OperatingSystemsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#operatingSystemsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Operating system collection. + # Corresponds to the JSON property `operatingSystems` + # @return [Array] + attr_accessor :operating_systems + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @operating_systems = args[:operating_systems] if args.key?(:operating_systems) + end + end + + # Creative optimization activity. + class OptimizationActivity + include Google::Apis::Core::Hashable + + # Floodlight activity ID of this optimization activity. This is a required field. + # Corresponds to the JSON property `floodlightActivityId` + # @return [Fixnum] + attr_accessor :floodlight_activity_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightActivityIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :floodlight_activity_id_dimension_value + + # Weight associated with this optimization. The weight assigned will be + # understood in proportion to the weights assigned to the other optimization + # activities. Value must be greater than or equal to 1. + # Corresponds to the JSON property `weight` + # @return [Fixnum] + attr_accessor :weight + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id) + @floodlight_activity_id_dimension_value = args[:floodlight_activity_id_dimension_value] if args.key?(:floodlight_activity_id_dimension_value) + @weight = args[:weight] if args.key?(:weight) + end + end + + # Describes properties of a DoubleClick Planning order. + class Order + include Google::Apis::Core::Hashable + + # Account ID of this order. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this order. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # IDs for users that have to approve documents created for this order. + # Corresponds to the JSON property `approverUserProfileIds` + # @return [Array] + attr_accessor :approver_user_profile_ids + + # Buyer invoice ID associated with this order. + # Corresponds to the JSON property `buyerInvoiceId` + # @return [String] + attr_accessor :buyer_invoice_id + + # Name of the buyer organization. + # Corresponds to the JSON property `buyerOrganizationName` + # @return [String] + attr_accessor :buyer_organization_name + + # Comments in this order. + # Corresponds to the JSON property `comments` + # @return [String] + attr_accessor :comments + + # Contacts for this order. + # Corresponds to the JSON property `contacts` + # @return [Array] + attr_accessor :contacts + + # ID of this order. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#order". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] + attr_accessor :last_modified_info + + # Name of this order. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Notes of this order. + # Corresponds to the JSON property `notes` + # @return [String] + attr_accessor :notes + + # ID of the terms and conditions template used in this order. + # Corresponds to the JSON property `planningTermId` + # @return [Fixnum] + attr_accessor :planning_term_id + + # Project ID of this order. + # Corresponds to the JSON property `projectId` + # @return [Fixnum] + attr_accessor :project_id + + # Seller order ID associated with this order. + # Corresponds to the JSON property `sellerOrderId` + # @return [String] + attr_accessor :seller_order_id + + # Name of the seller organization. + # Corresponds to the JSON property `sellerOrganizationName` + # @return [String] + attr_accessor :seller_organization_name + + # Site IDs this order is associated with. + # Corresponds to the JSON property `siteId` + # @return [Array] + attr_accessor :site_id + + # Free-form site names this order is associated with. + # Corresponds to the JSON property `siteNames` + # @return [Array] + attr_accessor :site_names + + # Subaccount ID of this order. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Terms and conditions of this order. + # Corresponds to the JSON property `termsAndConditions` + # @return [String] + attr_accessor :terms_and_conditions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @approver_user_profile_ids = args[:approver_user_profile_ids] if args.key?(:approver_user_profile_ids) + @buyer_invoice_id = args[:buyer_invoice_id] if args.key?(:buyer_invoice_id) + @buyer_organization_name = args[:buyer_organization_name] if args.key?(:buyer_organization_name) + @comments = args[:comments] if args.key?(:comments) + @contacts = args[:contacts] if args.key?(:contacts) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @name = args[:name] if args.key?(:name) + @notes = args[:notes] if args.key?(:notes) + @planning_term_id = args[:planning_term_id] if args.key?(:planning_term_id) + @project_id = args[:project_id] if args.key?(:project_id) + @seller_order_id = args[:seller_order_id] if args.key?(:seller_order_id) + @seller_organization_name = args[:seller_organization_name] if args.key?(:seller_organization_name) + @site_id = args[:site_id] if args.key?(:site_id) + @site_names = args[:site_names] if args.key?(:site_names) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @terms_and_conditions = args[:terms_and_conditions] if args.key?(:terms_and_conditions) + end + end + + # Contact of an order. + class OrderContact + include Google::Apis::Core::Hashable + + # Free-form information about this contact. It could be any information related + # to this contact in addition to type, title, name, and signature user profile + # ID. + # Corresponds to the JSON property `contactInfo` + # @return [String] + attr_accessor :contact_info + + # Name of this contact. + # Corresponds to the JSON property `contactName` + # @return [String] + attr_accessor :contact_name + + # Title of this contact. + # Corresponds to the JSON property `contactTitle` + # @return [String] + attr_accessor :contact_title + + # Type of this contact. + # Corresponds to the JSON property `contactType` + # @return [String] + attr_accessor :contact_type + + # ID of the user profile containing the signature that will be embedded into + # order documents. + # Corresponds to the JSON property `signatureUserProfileId` + # @return [Fixnum] + attr_accessor :signature_user_profile_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @contact_info = args[:contact_info] if args.key?(:contact_info) + @contact_name = args[:contact_name] if args.key?(:contact_name) + @contact_title = args[:contact_title] if args.key?(:contact_title) + @contact_type = args[:contact_type] if args.key?(:contact_type) + @signature_user_profile_id = args[:signature_user_profile_id] if args.key?(:signature_user_profile_id) + end + end + + # Contains properties of a DoubleClick Planning order document. + class OrderDocument + include Google::Apis::Core::Hashable + + # Account ID of this order document. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this order document. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # The amended order document ID of this order document. An order document can be + # created by optionally amending another order document so that the change + # history can be preserved. + # Corresponds to the JSON property `amendedOrderDocumentId` + # @return [Fixnum] + attr_accessor :amended_order_document_id + + # IDs of users who have approved this order document. + # Corresponds to the JSON property `approvedByUserProfileIds` + # @return [Array] + attr_accessor :approved_by_user_profile_ids + + # Whether this order document is cancelled. + # Corresponds to the JSON property `cancelled` + # @return [Boolean] + attr_accessor :cancelled + alias_method :cancelled?, :cancelled + + # Modification timestamp. + # Corresponds to the JSON property `createdInfo` + # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] + attr_accessor :created_info + + # Effective date of this order document. + # Corresponds to the JSON property `effectiveDate` + # @return [Date] + attr_accessor :effective_date + + # ID of this order document. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#orderDocument". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # List of email addresses that received the last sent document. + # Corresponds to the JSON property `lastSentRecipients` + # @return [Array] + attr_accessor :last_sent_recipients + + # Timestamp of the last email sent with this order document. + # Corresponds to the JSON property `lastSentTime` + # @return [DateTime] + attr_accessor :last_sent_time + + # ID of the order from which this order document is created. + # Corresponds to the JSON property `orderId` + # @return [Fixnum] + attr_accessor :order_id + + # Project ID of this order document. + # Corresponds to the JSON property `projectId` + # @return [Fixnum] + attr_accessor :project_id + + # Whether this order document has been signed. + # Corresponds to the JSON property `signed` + # @return [Boolean] + attr_accessor :signed + alias_method :signed?, :signed + + # Subaccount ID of this order document. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Title of this order document. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # Type of this order document + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @amended_order_document_id = args[:amended_order_document_id] if args.key?(:amended_order_document_id) + @approved_by_user_profile_ids = args[:approved_by_user_profile_ids] if args.key?(:approved_by_user_profile_ids) + @cancelled = args[:cancelled] if args.key?(:cancelled) + @created_info = args[:created_info] if args.key?(:created_info) + @effective_date = args[:effective_date] if args.key?(:effective_date) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @last_sent_recipients = args[:last_sent_recipients] if args.key?(:last_sent_recipients) + @last_sent_time = args[:last_sent_time] if args.key?(:last_sent_time) + @order_id = args[:order_id] if args.key?(:order_id) + @project_id = args[:project_id] if args.key?(:project_id) + @signed = args[:signed] if args.key?(:signed) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @title = args[:title] if args.key?(:title) + @type = args[:type] if args.key?(:type) + end + end + + # Order document List Response + class OrderDocumentsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#orderDocumentsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Order document collection + # Corresponds to the JSON property `orderDocuments` + # @return [Array] + attr_accessor :order_documents + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @order_documents = args[:order_documents] if args.key?(:order_documents) + end + end + + # Order List Response + class OrdersListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#ordersListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Order collection. + # Corresponds to the JSON property `orders` + # @return [Array] + attr_accessor :orders + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @orders = args[:orders] if args.key?(:orders) + end + end + + # Represents fields that are compatible to be selected for a report of type " + # PATH_TO_CONVERSION". + class PathToConversionReportCompatibleFields + include Google::Apis::Core::Hashable + + # Conversion dimensions which are compatible to be selected in the " + # conversionDimensions" section of the report. + # Corresponds to the JSON property `conversionDimensions` + # @return [Array] + attr_accessor :conversion_dimensions + + # Custom floodlight variables which are compatible to be selected in the " + # customFloodlightVariables" section of the report. + # Corresponds to the JSON property `customFloodlightVariables` + # @return [Array] + attr_accessor :custom_floodlight_variables + + # The kind of resource this is, in this case dfareporting# + # pathToConversionReportCompatibleFields. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metrics which are compatible to be selected in the "metricNames" section of + # the report. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Per-interaction dimensions which are compatible to be selected in the " + # perInteractionDimensions" section of the report. + # Corresponds to the JSON property `perInteractionDimensions` + # @return [Array] + attr_accessor :per_interaction_dimensions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @conversion_dimensions = args[:conversion_dimensions] if args.key?(:conversion_dimensions) + @custom_floodlight_variables = args[:custom_floodlight_variables] if args.key?(:custom_floodlight_variables) + @kind = args[:kind] if args.key?(:kind) + @metrics = args[:metrics] if args.key?(:metrics) + @per_interaction_dimensions = args[:per_interaction_dimensions] if args.key?(:per_interaction_dimensions) + end + end + + # Contains properties of a placement. + class Placement + include Google::Apis::Core::Hashable + + # Account ID of this placement. This field can be left blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Whether this placement opts out of ad blocking. When true, ad blocking is + # disabled for this placement. When false, the campaign and site settings take + # effect. + # Corresponds to the JSON property `adBlockingOptOut` + # @return [Boolean] + attr_accessor :ad_blocking_opt_out + alias_method :ad_blocking_opt_out?, :ad_blocking_opt_out + + # Advertiser ID of this placement. This field can be left blank. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Whether this placement is archived. + # Corresponds to the JSON property `archived` + # @return [Boolean] + attr_accessor :archived + alias_method :archived?, :archived + + # Campaign ID of this placement. This field is a required field on insertion. + # Corresponds to the JSON property `campaignId` + # @return [Fixnum] + attr_accessor :campaign_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `campaignIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :campaign_id_dimension_value + + # Comments for this placement. + # Corresponds to the JSON property `comment` + # @return [String] + attr_accessor :comment + + # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering + # on desktop, on mobile devices or in mobile apps for regular or interstitial + # ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new + # placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. + # IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the + # VAST standard. This field is required on insertion. + # Corresponds to the JSON property `compatibility` + # @return [String] + attr_accessor :compatibility + + # ID of the content category assigned to this placement. + # Corresponds to the JSON property `contentCategoryId` + # @return [Fixnum] + attr_accessor :content_category_id + + # Modification timestamp. + # Corresponds to the JSON property `createInfo` + # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] + attr_accessor :create_info + + # Directory site ID of this placement. On insert, you must set either this field + # or the siteId field to specify the site associated with this placement. This + # is a required field that is read-only after insertion. + # Corresponds to the JSON property `directorySiteId` + # @return [Fixnum] + attr_accessor :directory_site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `directorySiteIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :directory_site_id_dimension_value + + # External ID for this placement. + # Corresponds to the JSON property `externalId` + # @return [String] + attr_accessor :external_id + + # ID of this placement. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :id_dimension_value + + # Key name of this placement. This is a read-only, auto-generated field. + # Corresponds to the JSON property `keyName` + # @return [String] + attr_accessor :key_name + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#placement". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] + attr_accessor :last_modified_info + + # Lookback configuration settings. + # Corresponds to the JSON property `lookbackConfiguration` + # @return [Google::Apis::DfareportingV3_0::LookbackConfiguration] + attr_accessor :lookback_configuration + + # Name of this placement.This is a required field and must be less than 256 + # characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Whether payment was approved for this placement. This is a read-only field + # relevant only to publisher-paid placements. + # Corresponds to the JSON property `paymentApproved` + # @return [Boolean] + attr_accessor :payment_approved + alias_method :payment_approved?, :payment_approved + + # Payment source for this placement. This is a required field that is read-only + # after insertion. + # Corresponds to the JSON property `paymentSource` + # @return [String] + attr_accessor :payment_source + + # ID of this placement's group, if applicable. + # Corresponds to the JSON property `placementGroupId` + # @return [Fixnum] + attr_accessor :placement_group_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `placementGroupIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :placement_group_id_dimension_value + + # ID of the placement strategy assigned to this placement. + # Corresponds to the JSON property `placementStrategyId` + # @return [Fixnum] + attr_accessor :placement_strategy_id + + # Pricing Schedule + # Corresponds to the JSON property `pricingSchedule` + # @return [Google::Apis::DfareportingV3_0::PricingSchedule] + attr_accessor :pricing_schedule + + # Whether this placement is the primary placement of a roadblock (placement + # group). You cannot change this field from true to false. Setting this field to + # true will automatically set the primary field on the original primary + # placement of the roadblock to false, and it will automatically set the + # roadblock's primaryPlacementId field to the ID of this placement. + # Corresponds to the JSON property `primary` + # @return [Boolean] + attr_accessor :primary + alias_method :primary?, :primary + + # Modification timestamp. + # Corresponds to the JSON property `publisherUpdateInfo` + # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] + attr_accessor :publisher_update_info + + # Site ID associated with this placement. On insert, you must set either this + # field or the directorySiteId field to specify the site associated with this + # placement. This is a required field that is read-only after insertion. + # Corresponds to the JSON property `siteId` + # @return [Fixnum] + attr_accessor :site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `siteIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :site_id_dimension_value + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `size` + # @return [Google::Apis::DfareportingV3_0::Size] + attr_accessor :size + + # Whether creatives assigned to this placement must be SSL-compliant. + # Corresponds to the JSON property `sslRequired` + # @return [Boolean] + attr_accessor :ssl_required + alias_method :ssl_required?, :ssl_required + + # Third-party placement status. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # Subaccount ID of this placement. This field can be left blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Tag formats to generate for this placement. This field is required on + # insertion. + # Acceptable values are: + # - "PLACEMENT_TAG_STANDARD" + # - "PLACEMENT_TAG_IFRAME_JAVASCRIPT" + # - "PLACEMENT_TAG_IFRAME_ILAYER" + # - "PLACEMENT_TAG_INTERNAL_REDIRECT" + # - "PLACEMENT_TAG_JAVASCRIPT" + # - "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" + # - "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" + # - "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" + # - "PLACEMENT_TAG_CLICK_COMMANDS" + # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" + # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" + # - "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" + # - "PLACEMENT_TAG_TRACKING" + # - "PLACEMENT_TAG_TRACKING_IFRAME" + # - "PLACEMENT_TAG_TRACKING_JAVASCRIPT" + # Corresponds to the JSON property `tagFormats` + # @return [Array] + attr_accessor :tag_formats + + # Tag Settings + # Corresponds to the JSON property `tagSetting` + # @return [Google::Apis::DfareportingV3_0::TagSetting] + attr_accessor :tag_setting + + # Whether Verification and ActiveView are disabled for in-stream video creatives + # for this placement. The same setting videoActiveViewOptOut exists on the site + # level -- the opt out occurs if either of these settings are true. These + # settings are distinct from DirectorySites.settings.activeViewOptOut or Sites. + # siteSettings.activeViewOptOut which only apply to display ads. However, + # Accounts.activeViewOptOut opts out both video traffic, as well as display ads, + # from Verification and ActiveView. + # Corresponds to the JSON property `videoActiveViewOptOut` + # @return [Boolean] + attr_accessor :video_active_view_opt_out + alias_method :video_active_view_opt_out?, :video_active_view_opt_out + + # Video Settings + # Corresponds to the JSON property `videoSettings` + # @return [Google::Apis::DfareportingV3_0::VideoSettings] + attr_accessor :video_settings + + # VPAID adapter setting for this placement. Controls which VPAID format the + # measurement adapter will use for in-stream video creatives assigned to this + # placement. + # Note: Flash is no longer supported. This field now defaults to HTML5 when the + # following values are provided: FLASH, BOTH. + # Corresponds to the JSON property `vpaidAdapterChoice` + # @return [String] + attr_accessor :vpaid_adapter_choice + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @ad_blocking_opt_out = args[:ad_blocking_opt_out] if args.key?(:ad_blocking_opt_out) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @archived = args[:archived] if args.key?(:archived) + @campaign_id = args[:campaign_id] if args.key?(:campaign_id) + @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) + @comment = args[:comment] if args.key?(:comment) + @compatibility = args[:compatibility] if args.key?(:compatibility) + @content_category_id = args[:content_category_id] if args.key?(:content_category_id) + @create_info = args[:create_info] if args.key?(:create_info) + @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) + @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] if args.key?(:directory_site_id_dimension_value) + @external_id = args[:external_id] if args.key?(:external_id) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @key_name = args[:key_name] if args.key?(:key_name) + @kind = args[:kind] if args.key?(:kind) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) + @name = args[:name] if args.key?(:name) + @payment_approved = args[:payment_approved] if args.key?(:payment_approved) + @payment_source = args[:payment_source] if args.key?(:payment_source) + @placement_group_id = args[:placement_group_id] if args.key?(:placement_group_id) + @placement_group_id_dimension_value = args[:placement_group_id_dimension_value] if args.key?(:placement_group_id_dimension_value) + @placement_strategy_id = args[:placement_strategy_id] if args.key?(:placement_strategy_id) + @pricing_schedule = args[:pricing_schedule] if args.key?(:pricing_schedule) + @primary = args[:primary] if args.key?(:primary) + @publisher_update_info = args[:publisher_update_info] if args.key?(:publisher_update_info) + @site_id = args[:site_id] if args.key?(:site_id) + @site_id_dimension_value = args[:site_id_dimension_value] if args.key?(:site_id_dimension_value) + @size = args[:size] if args.key?(:size) + @ssl_required = args[:ssl_required] if args.key?(:ssl_required) + @status = args[:status] if args.key?(:status) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @tag_formats = args[:tag_formats] if args.key?(:tag_formats) + @tag_setting = args[:tag_setting] if args.key?(:tag_setting) + @video_active_view_opt_out = args[:video_active_view_opt_out] if args.key?(:video_active_view_opt_out) + @video_settings = args[:video_settings] if args.key?(:video_settings) + @vpaid_adapter_choice = args[:vpaid_adapter_choice] if args.key?(:vpaid_adapter_choice) + end + end + + # Placement Assignment. + class PlacementAssignment + include Google::Apis::Core::Hashable + + # Whether this placement assignment is active. When true, the placement will be + # included in the ad's rotation. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # ID of the placement to be assigned. This is a required field. + # Corresponds to the JSON property `placementId` + # @return [Fixnum] + attr_accessor :placement_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `placementIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :placement_id_dimension_value + + # Whether the placement to be assigned requires SSL. This is a read-only field + # that is auto-generated when the ad is inserted or updated. + # Corresponds to the JSON property `sslRequired` + # @return [Boolean] + attr_accessor :ssl_required + alias_method :ssl_required?, :ssl_required + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active = args[:active] if args.key?(:active) + @placement_id = args[:placement_id] if args.key?(:placement_id) + @placement_id_dimension_value = args[:placement_id_dimension_value] if args.key?(:placement_id_dimension_value) + @ssl_required = args[:ssl_required] if args.key?(:ssl_required) + end + end + + # Contains properties of a package or roadblock. + class PlacementGroup + include Google::Apis::Core::Hashable + + # Account ID of this placement group. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this placement group. This is a required field on insertion. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Whether this placement group is archived. + # Corresponds to the JSON property `archived` + # @return [Boolean] + attr_accessor :archived + alias_method :archived?, :archived + + # Campaign ID of this placement group. This field is required on insertion. + # Corresponds to the JSON property `campaignId` + # @return [Fixnum] + attr_accessor :campaign_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `campaignIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :campaign_id_dimension_value + + # IDs of placements which are assigned to this placement group. This is a read- + # only, auto-generated field. + # Corresponds to the JSON property `childPlacementIds` + # @return [Array] + attr_accessor :child_placement_ids + + # Comments for this placement group. + # Corresponds to the JSON property `comment` + # @return [String] + attr_accessor :comment + + # ID of the content category assigned to this placement group. + # Corresponds to the JSON property `contentCategoryId` + # @return [Fixnum] + attr_accessor :content_category_id + + # Modification timestamp. + # Corresponds to the JSON property `createInfo` + # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] + attr_accessor :create_info + + # Directory site ID associated with this placement group. On insert, you must + # set either this field or the site_id field to specify the site associated with + # this placement group. This is a required field that is read-only after + # insertion. + # Corresponds to the JSON property `directorySiteId` + # @return [Fixnum] + attr_accessor :directory_site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `directorySiteIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :directory_site_id_dimension_value + + # External ID for this placement. + # Corresponds to the JSON property `externalId` + # @return [String] + attr_accessor :external_id + + # ID of this placement group. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :id_dimension_value + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#placementGroup". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] + attr_accessor :last_modified_info + + # Name of this placement group. This is a required field and must be less than + # 256 characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Type of this placement group. A package is a simple group of placements that + # acts as a single pricing point for a group of tags. A roadblock is a group of + # placements that not only acts as a single pricing point, but also assumes that + # all the tags in it will be served at the same time. A roadblock requires one + # of its assigned placements to be marked as primary for reporting. This field + # is required on insertion. + # Corresponds to the JSON property `placementGroupType` + # @return [String] + attr_accessor :placement_group_type + + # ID of the placement strategy assigned to this placement group. + # Corresponds to the JSON property `placementStrategyId` + # @return [Fixnum] + attr_accessor :placement_strategy_id + + # Pricing Schedule + # Corresponds to the JSON property `pricingSchedule` + # @return [Google::Apis::DfareportingV3_0::PricingSchedule] + attr_accessor :pricing_schedule + + # ID of the primary placement, used to calculate the media cost of a roadblock ( + # placement group). Modifying this field will automatically modify the primary + # field on all affected roadblock child placements. + # Corresponds to the JSON property `primaryPlacementId` + # @return [Fixnum] + attr_accessor :primary_placement_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `primaryPlacementIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :primary_placement_id_dimension_value + + # Site ID associated with this placement group. On insert, you must set either + # this field or the directorySiteId field to specify the site associated with + # this placement group. This is a required field that is read-only after + # insertion. + # Corresponds to the JSON property `siteId` + # @return [Fixnum] + attr_accessor :site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `siteIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :site_id_dimension_value + + # Subaccount ID of this placement group. This is a read-only field that can be + # left blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @archived = args[:archived] if args.key?(:archived) + @campaign_id = args[:campaign_id] if args.key?(:campaign_id) + @campaign_id_dimension_value = args[:campaign_id_dimension_value] if args.key?(:campaign_id_dimension_value) + @child_placement_ids = args[:child_placement_ids] if args.key?(:child_placement_ids) + @comment = args[:comment] if args.key?(:comment) + @content_category_id = args[:content_category_id] if args.key?(:content_category_id) + @create_info = args[:create_info] if args.key?(:create_info) + @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) + @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] if args.key?(:directory_site_id_dimension_value) + @external_id = args[:external_id] if args.key?(:external_id) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @kind = args[:kind] if args.key?(:kind) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @name = args[:name] if args.key?(:name) + @placement_group_type = args[:placement_group_type] if args.key?(:placement_group_type) + @placement_strategy_id = args[:placement_strategy_id] if args.key?(:placement_strategy_id) + @pricing_schedule = args[:pricing_schedule] if args.key?(:pricing_schedule) + @primary_placement_id = args[:primary_placement_id] if args.key?(:primary_placement_id) + @primary_placement_id_dimension_value = args[:primary_placement_id_dimension_value] if args.key?(:primary_placement_id_dimension_value) + @site_id = args[:site_id] if args.key?(:site_id) + @site_id_dimension_value = args[:site_id_dimension_value] if args.key?(:site_id_dimension_value) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + end + end + + # Placement Group List Response + class PlacementGroupsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#placementGroupsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Placement group collection. + # Corresponds to the JSON property `placementGroups` + # @return [Array] + attr_accessor :placement_groups + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @placement_groups = args[:placement_groups] if args.key?(:placement_groups) + end + end + + # Placement Strategy List Response + class PlacementStrategiesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#placementStrategiesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Placement strategy collection. + # Corresponds to the JSON property `placementStrategies` + # @return [Array] + attr_accessor :placement_strategies + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @placement_strategies = args[:placement_strategies] if args.key?(:placement_strategies) + end + end + + # Contains properties of a placement strategy. + class PlacementStrategy + include Google::Apis::Core::Hashable + + # Account ID of this placement strategy.This is a read-only field that can be + # left blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # ID of this placement strategy. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#placementStrategy". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this placement strategy. This is a required field. It must be less + # than 256 characters long and unique among placement strategies of the same + # account. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Placement Tag + class PlacementTag + include Google::Apis::Core::Hashable + + # Placement ID + # Corresponds to the JSON property `placementId` + # @return [Fixnum] + attr_accessor :placement_id + + # Tags generated for this placement. + # Corresponds to the JSON property `tagDatas` + # @return [Array] + attr_accessor :tag_datas + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @placement_id = args[:placement_id] if args.key?(:placement_id) + @tag_datas = args[:tag_datas] if args.key?(:tag_datas) + end + end + + # Placement GenerateTags Response + class PlacementsGenerateTagsResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#placementsGenerateTagsResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Set of generated tags for the specified placements. + # Corresponds to the JSON property `placementTags` + # @return [Array] + attr_accessor :placement_tags + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @placement_tags = args[:placement_tags] if args.key?(:placement_tags) + end + end + + # Placement List Response + class PlacementsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#placementsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Placement collection. + # Corresponds to the JSON property `placements` + # @return [Array] + attr_accessor :placements + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @placements = args[:placements] if args.key?(:placements) + end + end + + # Contains information about a platform type that can be targeted by ads. + class PlatformType + include Google::Apis::Core::Hashable + + # ID of this platform type. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#platformType". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this platform type. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Platform Type List Response + class PlatformTypesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#platformTypesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Platform type collection. + # Corresponds to the JSON property `platformTypes` + # @return [Array] + attr_accessor :platform_types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @platform_types = args[:platform_types] if args.key?(:platform_types) + end + end + + # Popup Window Properties. + class PopupWindowProperties + include Google::Apis::Core::Hashable + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `dimension` + # @return [Google::Apis::DfareportingV3_0::Size] + attr_accessor :dimension + + # Offset Position. + # Corresponds to the JSON property `offset` + # @return [Google::Apis::DfareportingV3_0::OffsetPosition] + attr_accessor :offset + + # Popup window position either centered or at specific coordinate. + # Corresponds to the JSON property `positionType` + # @return [String] + attr_accessor :position_type + + # Whether to display the browser address bar. + # Corresponds to the JSON property `showAddressBar` + # @return [Boolean] + attr_accessor :show_address_bar + alias_method :show_address_bar?, :show_address_bar + + # Whether to display the browser menu bar. + # Corresponds to the JSON property `showMenuBar` + # @return [Boolean] + attr_accessor :show_menu_bar + alias_method :show_menu_bar?, :show_menu_bar + + # Whether to display the browser scroll bar. + # Corresponds to the JSON property `showScrollBar` + # @return [Boolean] + attr_accessor :show_scroll_bar + alias_method :show_scroll_bar?, :show_scroll_bar + + # Whether to display the browser status bar. + # Corresponds to the JSON property `showStatusBar` + # @return [Boolean] + attr_accessor :show_status_bar + alias_method :show_status_bar?, :show_status_bar + + # Whether to display the browser tool bar. + # Corresponds to the JSON property `showToolBar` + # @return [Boolean] + attr_accessor :show_tool_bar + alias_method :show_tool_bar?, :show_tool_bar + + # Title of popup window. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension = args[:dimension] if args.key?(:dimension) + @offset = args[:offset] if args.key?(:offset) + @position_type = args[:position_type] if args.key?(:position_type) + @show_address_bar = args[:show_address_bar] if args.key?(:show_address_bar) + @show_menu_bar = args[:show_menu_bar] if args.key?(:show_menu_bar) + @show_scroll_bar = args[:show_scroll_bar] if args.key?(:show_scroll_bar) + @show_status_bar = args[:show_status_bar] if args.key?(:show_status_bar) + @show_tool_bar = args[:show_tool_bar] if args.key?(:show_tool_bar) + @title = args[:title] if args.key?(:title) + end + end + + # Contains information about a postal code that can be targeted by ads. + class PostalCode + include Google::Apis::Core::Hashable + + # Postal code. This is equivalent to the id field. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # Country code of the country to which this postal code belongs. + # Corresponds to the JSON property `countryCode` + # @return [String] + attr_accessor :country_code + + # DART ID of the country to which this postal code belongs. + # Corresponds to the JSON property `countryDartId` + # @return [Fixnum] + attr_accessor :country_dart_id + + # ID of this postal code. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#postalCode". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @country_code = args[:country_code] if args.key?(:country_code) + @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Postal Code List Response + class PostalCodesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#postalCodesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Postal code collection. + # Corresponds to the JSON property `postalCodes` + # @return [Array] + attr_accessor :postal_codes + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @postal_codes = args[:postal_codes] if args.key?(:postal_codes) + end + end + + # Pricing Information + class Pricing + include Google::Apis::Core::Hashable + + # Cap cost type of this inventory item. + # Corresponds to the JSON property `capCostType` + # @return [String] + attr_accessor :cap_cost_type + + # End date of this inventory item. + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # Flights of this inventory item. A flight (a.k.a. pricing period) represents + # the inventory item pricing information for a specific period of time. + # Corresponds to the JSON property `flights` + # @return [Array] + attr_accessor :flights + + # Group type of this inventory item if it represents a placement group. Is null + # otherwise. There are two type of placement groups: + # PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory items + # that acts as a single pricing point for a group of tags. + # PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items that not + # only acts as a single pricing point, but also assumes that all the tags in it + # will be served at the same time. A roadblock requires one of its assigned + # inventory items to be marked as primary. + # Corresponds to the JSON property `groupType` + # @return [String] + attr_accessor :group_type + + # Pricing type of this inventory item. + # Corresponds to the JSON property `pricingType` + # @return [String] + attr_accessor :pricing_type + + # Start date of this inventory item. + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cap_cost_type = args[:cap_cost_type] if args.key?(:cap_cost_type) + @end_date = args[:end_date] if args.key?(:end_date) + @flights = args[:flights] if args.key?(:flights) + @group_type = args[:group_type] if args.key?(:group_type) + @pricing_type = args[:pricing_type] if args.key?(:pricing_type) + @start_date = args[:start_date] if args.key?(:start_date) + end + end + + # Pricing Schedule + class PricingSchedule + include Google::Apis::Core::Hashable + + # Placement cap cost option. + # Corresponds to the JSON property `capCostOption` + # @return [String] + attr_accessor :cap_cost_option + + # Whether cap costs are ignored by ad serving. + # Corresponds to the JSON property `disregardOverdelivery` + # @return [Boolean] + attr_accessor :disregard_overdelivery + alias_method :disregard_overdelivery?, :disregard_overdelivery + + # Placement end date. This date must be later than, or the same day as, the + # placement start date, but not later than the campaign end date. If, for + # example, you set 6/25/2015 as both the start and end dates, the effective + # placement date is just that day only, 6/25/2015. The hours, minutes, and + # seconds of the end date should not be set, as doing so will result in an error. + # This field is required on insertion. + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # Whether this placement is flighted. If true, pricing periods will be computed + # automatically. + # Corresponds to the JSON property `flighted` + # @return [Boolean] + attr_accessor :flighted + alias_method :flighted?, :flighted + + # Floodlight activity ID associated with this placement. This field should be + # set when placement pricing type is set to PRICING_TYPE_CPA. + # Corresponds to the JSON property `floodlightActivityId` + # @return [Fixnum] + attr_accessor :floodlight_activity_id + + # Pricing periods for this placement. + # Corresponds to the JSON property `pricingPeriods` + # @return [Array] + attr_accessor :pricing_periods + + # Placement pricing type. This field is required on insertion. + # Corresponds to the JSON property `pricingType` + # @return [String] + attr_accessor :pricing_type + + # Placement start date. This date must be later than, or the same day as, the + # campaign start date. The hours, minutes, and seconds of the start date should + # not be set, as doing so will result in an error. This field is required on + # insertion. + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + # Testing start date of this placement. The hours, minutes, and seconds of the + # start date should not be set, as doing so will result in an error. + # Corresponds to the JSON property `testingStartDate` + # @return [Date] + attr_accessor :testing_start_date + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cap_cost_option = args[:cap_cost_option] if args.key?(:cap_cost_option) + @disregard_overdelivery = args[:disregard_overdelivery] if args.key?(:disregard_overdelivery) + @end_date = args[:end_date] if args.key?(:end_date) + @flighted = args[:flighted] if args.key?(:flighted) + @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id) + @pricing_periods = args[:pricing_periods] if args.key?(:pricing_periods) + @pricing_type = args[:pricing_type] if args.key?(:pricing_type) + @start_date = args[:start_date] if args.key?(:start_date) + @testing_start_date = args[:testing_start_date] if args.key?(:testing_start_date) + end + end + + # Pricing Period + class PricingSchedulePricingPeriod + include Google::Apis::Core::Hashable + + # Pricing period end date. This date must be later than, or the same day as, the + # pricing period start date, but not later than the placement end date. The + # period end date can be the same date as the period start date. If, for example, + # you set 6/25/2015 as both the start and end dates, the effective pricing + # period date is just that day only, 6/25/2015. The hours, minutes, and seconds + # of the end date should not be set, as doing so will result in an error. + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # Comments for this pricing period. + # Corresponds to the JSON property `pricingComment` + # @return [String] + attr_accessor :pricing_comment + + # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). + # Acceptable values are 0 to 1000000000000000000, inclusive. + # Corresponds to the JSON property `rateOrCostNanos` + # @return [Fixnum] + attr_accessor :rate_or_cost_nanos + + # Pricing period start date. This date must be later than, or the same day as, + # the placement start date. The hours, minutes, and seconds of the start date + # should not be set, as doing so will result in an error. + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + # Units of this pricing period. Acceptable values are 0 to 10000000000, + # inclusive. + # Corresponds to the JSON property `units` + # @return [Fixnum] + attr_accessor :units + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_date = args[:end_date] if args.key?(:end_date) + @pricing_comment = args[:pricing_comment] if args.key?(:pricing_comment) + @rate_or_cost_nanos = args[:rate_or_cost_nanos] if args.key?(:rate_or_cost_nanos) + @start_date = args[:start_date] if args.key?(:start_date) + @units = args[:units] if args.key?(:units) + end + end + + # Contains properties of a DoubleClick Planning project. + class Project + include Google::Apis::Core::Hashable + + # Account ID of this project. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this project. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Audience age group of this project. + # Corresponds to the JSON property `audienceAgeGroup` + # @return [String] + attr_accessor :audience_age_group + + # Audience gender of this project. + # Corresponds to the JSON property `audienceGender` + # @return [String] + attr_accessor :audience_gender + + # Budget of this project in the currency specified by the current account. The + # value stored in this field represents only the non-fractional amount. For + # example, for USD, the smallest value that can be represented by this field is + # 1 US dollar. + # Corresponds to the JSON property `budget` + # @return [Fixnum] + attr_accessor :budget + + # Client billing code of this project. + # Corresponds to the JSON property `clientBillingCode` + # @return [String] + attr_accessor :client_billing_code + + # Name of the project client. + # Corresponds to the JSON property `clientName` + # @return [String] + attr_accessor :client_name + + # End date of the project. + # Corresponds to the JSON property `endDate` + # @return [Date] + attr_accessor :end_date + + # ID of this project. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#project". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Modification timestamp. + # Corresponds to the JSON property `lastModifiedInfo` + # @return [Google::Apis::DfareportingV3_0::LastModifiedInfo] + attr_accessor :last_modified_info + + # Name of this project. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Overview of this project. + # Corresponds to the JSON property `overview` + # @return [String] + attr_accessor :overview + + # Start date of the project. + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + # Subaccount ID of this project. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Number of clicks that the advertiser is targeting. + # Corresponds to the JSON property `targetClicks` + # @return [Fixnum] + attr_accessor :target_clicks + + # Number of conversions that the advertiser is targeting. + # Corresponds to the JSON property `targetConversions` + # @return [Fixnum] + attr_accessor :target_conversions + + # CPA that the advertiser is targeting. + # Corresponds to the JSON property `targetCpaNanos` + # @return [Fixnum] + attr_accessor :target_cpa_nanos + + # CPC that the advertiser is targeting. + # Corresponds to the JSON property `targetCpcNanos` + # @return [Fixnum] + attr_accessor :target_cpc_nanos + + # vCPM from Active View that the advertiser is targeting. + # Corresponds to the JSON property `targetCpmActiveViewNanos` + # @return [Fixnum] + attr_accessor :target_cpm_active_view_nanos + + # CPM that the advertiser is targeting. + # Corresponds to the JSON property `targetCpmNanos` + # @return [Fixnum] + attr_accessor :target_cpm_nanos + + # Number of impressions that the advertiser is targeting. + # Corresponds to the JSON property `targetImpressions` + # @return [Fixnum] + attr_accessor :target_impressions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @audience_age_group = args[:audience_age_group] if args.key?(:audience_age_group) + @audience_gender = args[:audience_gender] if args.key?(:audience_gender) + @budget = args[:budget] if args.key?(:budget) + @client_billing_code = args[:client_billing_code] if args.key?(:client_billing_code) + @client_name = args[:client_name] if args.key?(:client_name) + @end_date = args[:end_date] if args.key?(:end_date) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) + @name = args[:name] if args.key?(:name) + @overview = args[:overview] if args.key?(:overview) + @start_date = args[:start_date] if args.key?(:start_date) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @target_clicks = args[:target_clicks] if args.key?(:target_clicks) + @target_conversions = args[:target_conversions] if args.key?(:target_conversions) + @target_cpa_nanos = args[:target_cpa_nanos] if args.key?(:target_cpa_nanos) + @target_cpc_nanos = args[:target_cpc_nanos] if args.key?(:target_cpc_nanos) + @target_cpm_active_view_nanos = args[:target_cpm_active_view_nanos] if args.key?(:target_cpm_active_view_nanos) + @target_cpm_nanos = args[:target_cpm_nanos] if args.key?(:target_cpm_nanos) + @target_impressions = args[:target_impressions] if args.key?(:target_impressions) + end + end + + # Project List Response + class ProjectsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#projectsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Project collection. + # Corresponds to the JSON property `projects` + # @return [Array] + attr_accessor :projects + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @projects = args[:projects] if args.key?(:projects) + end + end + + # Represents fields that are compatible to be selected for a report of type " + # REACH". + class ReachReportCompatibleFields + include Google::Apis::Core::Hashable + + # Dimensions which are compatible to be selected in the "dimensionFilters" + # section of the report. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # Dimensions which are compatible to be selected in the "dimensions" section of + # the report. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # The kind of resource this is, in this case dfareporting# + # reachReportCompatibleFields. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metrics which are compatible to be selected in the "metricNames" section of + # the report. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Metrics which are compatible to be selected as activity metrics to pivot on in + # the "activities" section of the report. + # Corresponds to the JSON property `pivotedActivityMetrics` + # @return [Array] + attr_accessor :pivoted_activity_metrics + + # Metrics which are compatible to be selected in the " + # reachByFrequencyMetricNames" section of the report. + # Corresponds to the JSON property `reachByFrequencyMetrics` + # @return [Array] + attr_accessor :reach_by_frequency_metrics + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @kind = args[:kind] if args.key?(:kind) + @metrics = args[:metrics] if args.key?(:metrics) + @pivoted_activity_metrics = args[:pivoted_activity_metrics] if args.key?(:pivoted_activity_metrics) + @reach_by_frequency_metrics = args[:reach_by_frequency_metrics] if args.key?(:reach_by_frequency_metrics) + end + end + + # Represents a recipient. + class Recipient + include Google::Apis::Core::Hashable + + # The delivery type for the recipient. + # Corresponds to the JSON property `deliveryType` + # @return [String] + attr_accessor :delivery_type + + # The email address of the recipient. + # Corresponds to the JSON property `email` + # @return [String] + attr_accessor :email + + # The kind of resource this is, in this case dfareporting#recipient. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @delivery_type = args[:delivery_type] if args.key?(:delivery_type) + @email = args[:email] if args.key?(:email) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Contains information about a region that can be targeted by ads. + class Region + include Google::Apis::Core::Hashable + + # Country code of the country to which this region belongs. + # Corresponds to the JSON property `countryCode` + # @return [String] + attr_accessor :country_code + + # DART ID of the country to which this region belongs. + # Corresponds to the JSON property `countryDartId` + # @return [Fixnum] + attr_accessor :country_dart_id + + # DART ID of this region. + # Corresponds to the JSON property `dartId` + # @return [Fixnum] + attr_accessor :dart_id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#region". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this region. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Region code. + # Corresponds to the JSON property `regionCode` + # @return [String] + attr_accessor :region_code + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @country_code = args[:country_code] if args.key?(:country_code) + @country_dart_id = args[:country_dart_id] if args.key?(:country_dart_id) + @dart_id = args[:dart_id] if args.key?(:dart_id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @region_code = args[:region_code] if args.key?(:region_code) + end + end + + # Region List Response + class RegionsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#regionsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Region collection. + # Corresponds to the JSON property `regions` + # @return [Array] + attr_accessor :regions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @regions = args[:regions] if args.key?(:regions) + end + end + + # Contains properties of a remarketing list. Remarketing enables you to create + # lists of users who have performed specific actions on a site, then target ads + # to members of those lists. This resource can be used to manage remarketing + # lists that are owned by your advertisers. To see all remarketing lists that + # are visible to your advertisers, including those that are shared to your + # advertiser or account, use the TargetableRemarketingLists resource. + class RemarketingList + include Google::Apis::Core::Hashable + + # Account ID of this remarketing list. This is a read-only, auto-generated field + # that is only returned in GET requests. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Whether this remarketing list is active. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Dimension value for the advertiser ID that owns this remarketing list. This is + # a required field. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Remarketing list description. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Remarketing list ID. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#remarketingList". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Number of days that a user should remain in the remarketing list without an + # impression. Acceptable values are 1 to 540, inclusive. + # Corresponds to the JSON property `lifeSpan` + # @return [Fixnum] + attr_accessor :life_span + + # Remarketing List Population Rule. + # Corresponds to the JSON property `listPopulationRule` + # @return [Google::Apis::DfareportingV3_0::ListPopulationRule] + attr_accessor :list_population_rule + + # Number of users currently in the list. This is a read-only field. + # Corresponds to the JSON property `listSize` + # @return [Fixnum] + attr_accessor :list_size + + # Product from which this remarketing list was originated. + # Corresponds to the JSON property `listSource` + # @return [String] + attr_accessor :list_source + + # Name of the remarketing list. This is a required field. Must be no greater + # than 128 characters long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Subaccount ID of this remarketing list. This is a read-only, auto-generated + # field that is only returned in GET requests. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @active = args[:active] if args.key?(:active) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @description = args[:description] if args.key?(:description) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @life_span = args[:life_span] if args.key?(:life_span) + @list_population_rule = args[:list_population_rule] if args.key?(:list_population_rule) + @list_size = args[:list_size] if args.key?(:list_size) + @list_source = args[:list_source] if args.key?(:list_source) + @name = args[:name] if args.key?(:name) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + end + end + + # Contains properties of a remarketing list's sharing information. Sharing + # allows other accounts or advertisers to target to your remarketing lists. This + # resource can be used to manage remarketing list sharing to other accounts and + # advertisers. + class RemarketingListShare + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#remarketingListShare". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Remarketing list ID. This is a read-only, auto-generated field. + # Corresponds to the JSON property `remarketingListId` + # @return [Fixnum] + attr_accessor :remarketing_list_id + + # Accounts that the remarketing list is shared with. + # Corresponds to the JSON property `sharedAccountIds` + # @return [Array] + attr_accessor :shared_account_ids + + # Advertisers that the remarketing list is shared with. + # Corresponds to the JSON property `sharedAdvertiserIds` + # @return [Array] + attr_accessor :shared_advertiser_ids + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @remarketing_list_id = args[:remarketing_list_id] if args.key?(:remarketing_list_id) + @shared_account_ids = args[:shared_account_ids] if args.key?(:shared_account_ids) + @shared_advertiser_ids = args[:shared_advertiser_ids] if args.key?(:shared_advertiser_ids) + end + end + + # Remarketing list response + class RemarketingListsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#remarketingListsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Remarketing list collection. + # Corresponds to the JSON property `remarketingLists` + # @return [Array] + attr_accessor :remarketing_lists + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @remarketing_lists = args[:remarketing_lists] if args.key?(:remarketing_lists) + end + end + + # Represents a Report resource. + class Report + include Google::Apis::Core::Hashable + + # The account ID to which this report belongs. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # The report criteria for a report of type "STANDARD". + # Corresponds to the JSON property `criteria` + # @return [Google::Apis::DfareportingV3_0::Report::Criteria] + attr_accessor :criteria + + # The report criteria for a report of type "CROSS_DIMENSION_REACH". + # Corresponds to the JSON property `crossDimensionReachCriteria` + # @return [Google::Apis::DfareportingV3_0::Report::CrossDimensionReachCriteria] + attr_accessor :cross_dimension_reach_criteria + + # The report's email delivery settings. + # Corresponds to the JSON property `delivery` + # @return [Google::Apis::DfareportingV3_0::Report::Delivery] + attr_accessor :delivery + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The filename used when generating report files for this report. + # Corresponds to the JSON property `fileName` + # @return [String] + attr_accessor :file_name + + # The report criteria for a report of type "FLOODLIGHT". + # Corresponds to the JSON property `floodlightCriteria` + # @return [Google::Apis::DfareportingV3_0::Report::FloodlightCriteria] + attr_accessor :floodlight_criteria + + # The output format of the report. If not specified, default format is "CSV". + # Note that the actual format in the completed report file might differ if for + # instance the report's size exceeds the format's capabilities. "CSV" will then + # be the fallback format. + # Corresponds to the JSON property `format` + # @return [String] + attr_accessor :format + + # The unique ID identifying this report resource. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # The kind of resource this is, in this case dfareporting#report. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The timestamp (in milliseconds since epoch) of when this report was last + # modified. + # Corresponds to the JSON property `lastModifiedTime` + # @return [Fixnum] + attr_accessor :last_modified_time + + # The name of the report. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The user profile id of the owner of this report. + # Corresponds to the JSON property `ownerProfileId` + # @return [Fixnum] + attr_accessor :owner_profile_id + + # The report criteria for a report of type "PATH_TO_CONVERSION". + # Corresponds to the JSON property `pathToConversionCriteria` + # @return [Google::Apis::DfareportingV3_0::Report::PathToConversionCriteria] + attr_accessor :path_to_conversion_criteria + + # The report criteria for a report of type "REACH". + # Corresponds to the JSON property `reachCriteria` + # @return [Google::Apis::DfareportingV3_0::Report::ReachCriteria] + attr_accessor :reach_criteria + + # The report's schedule. Can only be set if the report's 'dateRange' is a + # relative date range and the relative date range is not "TODAY". + # Corresponds to the JSON property `schedule` + # @return [Google::Apis::DfareportingV3_0::Report::Schedule] + attr_accessor :schedule + + # The subaccount ID to which this report belongs if applicable. + # Corresponds to the JSON property `subAccountId` + # @return [Fixnum] + attr_accessor :sub_account_id + + # The type of the report. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @criteria = args[:criteria] if args.key?(:criteria) + @cross_dimension_reach_criteria = args[:cross_dimension_reach_criteria] if args.key?(:cross_dimension_reach_criteria) + @delivery = args[:delivery] if args.key?(:delivery) + @etag = args[:etag] if args.key?(:etag) + @file_name = args[:file_name] if args.key?(:file_name) + @floodlight_criteria = args[:floodlight_criteria] if args.key?(:floodlight_criteria) + @format = args[:format] if args.key?(:format) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time) + @name = args[:name] if args.key?(:name) + @owner_profile_id = args[:owner_profile_id] if args.key?(:owner_profile_id) + @path_to_conversion_criteria = args[:path_to_conversion_criteria] if args.key?(:path_to_conversion_criteria) + @reach_criteria = args[:reach_criteria] if args.key?(:reach_criteria) + @schedule = args[:schedule] if args.key?(:schedule) + @sub_account_id = args[:sub_account_id] if args.key?(:sub_account_id) + @type = args[:type] if args.key?(:type) + end + + # The report criteria for a report of type "STANDARD". + class Criteria + include Google::Apis::Core::Hashable + + # Represents an activity group. + # Corresponds to the JSON property `activities` + # @return [Google::Apis::DfareportingV3_0::Activities] + attr_accessor :activities + + # Represents a Custom Rich Media Events group. + # Corresponds to the JSON property `customRichMediaEvents` + # @return [Google::Apis::DfareportingV3_0::CustomRichMediaEvents] + attr_accessor :custom_rich_media_events + + # Represents a date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DfareportingV3_0::DateRange] + attr_accessor :date_range + + # The list of filters on which dimensions are filtered. + # Filters for different dimensions are ANDed, filters for the same dimension are + # grouped together and ORed. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # The list of standard dimensions the report should include. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # The list of names of metrics the report should include. + # Corresponds to the JSON property `metricNames` + # @return [Array] + attr_accessor :metric_names + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @activities = args[:activities] if args.key?(:activities) + @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) + @date_range = args[:date_range] if args.key?(:date_range) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @metric_names = args[:metric_names] if args.key?(:metric_names) + end + end + + # The report criteria for a report of type "CROSS_DIMENSION_REACH". + class CrossDimensionReachCriteria + include Google::Apis::Core::Hashable + + # The list of dimensions the report should include. + # Corresponds to the JSON property `breakdown` + # @return [Array] + attr_accessor :breakdown + + # Represents a date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DfareportingV3_0::DateRange] + attr_accessor :date_range + + # The dimension option. + # Corresponds to the JSON property `dimension` + # @return [String] + attr_accessor :dimension + + # The list of filters on which dimensions are filtered. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # The list of names of metrics the report should include. + # Corresponds to the JSON property `metricNames` + # @return [Array] + attr_accessor :metric_names + + # The list of names of overlap metrics the report should include. + # Corresponds to the JSON property `overlapMetricNames` + # @return [Array] + attr_accessor :overlap_metric_names + + # Whether the report is pivoted or not. Defaults to true. + # Corresponds to the JSON property `pivoted` + # @return [Boolean] + attr_accessor :pivoted + alias_method :pivoted?, :pivoted + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @breakdown = args[:breakdown] if args.key?(:breakdown) + @date_range = args[:date_range] if args.key?(:date_range) + @dimension = args[:dimension] if args.key?(:dimension) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @metric_names = args[:metric_names] if args.key?(:metric_names) + @overlap_metric_names = args[:overlap_metric_names] if args.key?(:overlap_metric_names) + @pivoted = args[:pivoted] if args.key?(:pivoted) + end + end + + # The report's email delivery settings. + class Delivery + include Google::Apis::Core::Hashable + + # Whether the report should be emailed to the report owner. + # Corresponds to the JSON property `emailOwner` + # @return [Boolean] + attr_accessor :email_owner + alias_method :email_owner?, :email_owner + + # The type of delivery for the owner to receive, if enabled. + # Corresponds to the JSON property `emailOwnerDeliveryType` + # @return [String] + attr_accessor :email_owner_delivery_type + + # The message to be sent with each email. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + # The list of recipients to which to email the report. + # Corresponds to the JSON property `recipients` + # @return [Array] + attr_accessor :recipients + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @email_owner = args[:email_owner] if args.key?(:email_owner) + @email_owner_delivery_type = args[:email_owner_delivery_type] if args.key?(:email_owner_delivery_type) + @message = args[:message] if args.key?(:message) + @recipients = args[:recipients] if args.key?(:recipients) + end + end + + # The report criteria for a report of type "FLOODLIGHT". + class FloodlightCriteria + include Google::Apis::Core::Hashable + + # The list of custom rich media events to include. + # Corresponds to the JSON property `customRichMediaEvents` + # @return [Array] + attr_accessor :custom_rich_media_events + + # Represents a date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DfareportingV3_0::DateRange] + attr_accessor :date_range + + # The list of filters on which dimensions are filtered. + # Filters for different dimensions are ANDed, filters for the same dimension are + # grouped together and ORed. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # The list of dimensions the report should include. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightConfigId` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :floodlight_config_id + + # The list of names of metrics the report should include. + # Corresponds to the JSON property `metricNames` + # @return [Array] + attr_accessor :metric_names + + # The properties of the report. + # Corresponds to the JSON property `reportProperties` + # @return [Google::Apis::DfareportingV3_0::Report::FloodlightCriteria::ReportProperties] + attr_accessor :report_properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) + @date_range = args[:date_range] if args.key?(:date_range) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @floodlight_config_id = args[:floodlight_config_id] if args.key?(:floodlight_config_id) + @metric_names = args[:metric_names] if args.key?(:metric_names) + @report_properties = args[:report_properties] if args.key?(:report_properties) + end + + # The properties of the report. + class ReportProperties + include Google::Apis::Core::Hashable + + # Include conversions that have no cookie, but do have an exposure path. + # Corresponds to the JSON property `includeAttributedIPConversions` + # @return [Boolean] + attr_accessor :include_attributed_ip_conversions + alias_method :include_attributed_ip_conversions?, :include_attributed_ip_conversions + + # Include conversions of users with a DoubleClick cookie but without an exposure. + # That means the user did not click or see an ad from the advertiser within the + # Floodlight group, or that the interaction happened outside the lookback window. + # Corresponds to the JSON property `includeUnattributedCookieConversions` + # @return [Boolean] + attr_accessor :include_unattributed_cookie_conversions + alias_method :include_unattributed_cookie_conversions?, :include_unattributed_cookie_conversions + + # Include conversions that have no associated cookies and no exposures. It’s + # therefore impossible to know how the user was exposed to your ads during the + # lookback window prior to a conversion. + # Corresponds to the JSON property `includeUnattributedIPConversions` + # @return [Boolean] + attr_accessor :include_unattributed_ip_conversions + alias_method :include_unattributed_ip_conversions?, :include_unattributed_ip_conversions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @include_attributed_ip_conversions = args[:include_attributed_ip_conversions] if args.key?(:include_attributed_ip_conversions) + @include_unattributed_cookie_conversions = args[:include_unattributed_cookie_conversions] if args.key?(:include_unattributed_cookie_conversions) + @include_unattributed_ip_conversions = args[:include_unattributed_ip_conversions] if args.key?(:include_unattributed_ip_conversions) + end + end + end + + # The report criteria for a report of type "PATH_TO_CONVERSION". + class PathToConversionCriteria + include Google::Apis::Core::Hashable + + # The list of 'dfa:activity' values to filter on. + # Corresponds to the JSON property `activityFilters` + # @return [Array] + attr_accessor :activity_filters + + # The list of conversion dimensions the report should include. + # Corresponds to the JSON property `conversionDimensions` + # @return [Array] + attr_accessor :conversion_dimensions + + # The list of custom floodlight variables the report should include. + # Corresponds to the JSON property `customFloodlightVariables` + # @return [Array] + attr_accessor :custom_floodlight_variables + + # The list of custom rich media events to include. + # Corresponds to the JSON property `customRichMediaEvents` + # @return [Array] + attr_accessor :custom_rich_media_events + + # Represents a date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DfareportingV3_0::DateRange] + attr_accessor :date_range + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `floodlightConfigId` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :floodlight_config_id + + # The list of names of metrics the report should include. + # Corresponds to the JSON property `metricNames` + # @return [Array] + attr_accessor :metric_names + + # The list of per interaction dimensions the report should include. + # Corresponds to the JSON property `perInteractionDimensions` + # @return [Array] + attr_accessor :per_interaction_dimensions + + # The properties of the report. + # Corresponds to the JSON property `reportProperties` + # @return [Google::Apis::DfareportingV3_0::Report::PathToConversionCriteria::ReportProperties] + attr_accessor :report_properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @activity_filters = args[:activity_filters] if args.key?(:activity_filters) + @conversion_dimensions = args[:conversion_dimensions] if args.key?(:conversion_dimensions) + @custom_floodlight_variables = args[:custom_floodlight_variables] if args.key?(:custom_floodlight_variables) + @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) + @date_range = args[:date_range] if args.key?(:date_range) + @floodlight_config_id = args[:floodlight_config_id] if args.key?(:floodlight_config_id) + @metric_names = args[:metric_names] if args.key?(:metric_names) + @per_interaction_dimensions = args[:per_interaction_dimensions] if args.key?(:per_interaction_dimensions) + @report_properties = args[:report_properties] if args.key?(:report_properties) + end + + # The properties of the report. + class ReportProperties + include Google::Apis::Core::Hashable + + # DFA checks to see if a click interaction occurred within the specified period + # of time before a conversion. By default the value is pulled from Floodlight or + # you can manually enter a custom value. Valid values: 1-90. + # Corresponds to the JSON property `clicksLookbackWindow` + # @return [Fixnum] + attr_accessor :clicks_lookback_window + + # DFA checks to see if an impression interaction occurred within the specified + # period of time before a conversion. By default the value is pulled from + # Floodlight or you can manually enter a custom value. Valid values: 1-90. + # Corresponds to the JSON property `impressionsLookbackWindow` + # @return [Fixnum] + attr_accessor :impressions_lookback_window + + # Deprecated: has no effect. + # Corresponds to the JSON property `includeAttributedIPConversions` + # @return [Boolean] + attr_accessor :include_attributed_ip_conversions + alias_method :include_attributed_ip_conversions?, :include_attributed_ip_conversions + + # Include conversions of users with a DoubleClick cookie but without an exposure. + # That means the user did not click or see an ad from the advertiser within the + # Floodlight group, or that the interaction happened outside the lookback window. + # Corresponds to the JSON property `includeUnattributedCookieConversions` + # @return [Boolean] + attr_accessor :include_unattributed_cookie_conversions + alias_method :include_unattributed_cookie_conversions?, :include_unattributed_cookie_conversions + + # Include conversions that have no associated cookies and no exposures. It’s + # therefore impossible to know how the user was exposed to your ads during the + # lookback window prior to a conversion. + # Corresponds to the JSON property `includeUnattributedIPConversions` + # @return [Boolean] + attr_accessor :include_unattributed_ip_conversions + alias_method :include_unattributed_ip_conversions?, :include_unattributed_ip_conversions + + # The maximum number of click interactions to include in the report. Advertisers + # currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). + # If another advertiser in your network is paying for E2C, you can have up to 5 + # total exposures per report. + # Corresponds to the JSON property `maximumClickInteractions` + # @return [Fixnum] + attr_accessor :maximum_click_interactions + + # The maximum number of click interactions to include in the report. Advertisers + # currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). + # If another advertiser in your network is paying for E2C, you can have up to 5 + # total exposures per report. + # Corresponds to the JSON property `maximumImpressionInteractions` + # @return [Fixnum] + attr_accessor :maximum_impression_interactions + + # The maximum amount of time that can take place between interactions (clicks or + # impressions) by the same user. Valid values: 1-90. + # Corresponds to the JSON property `maximumInteractionGap` + # @return [Fixnum] + attr_accessor :maximum_interaction_gap + + # Enable pivoting on interaction path. + # Corresponds to the JSON property `pivotOnInteractionPath` + # @return [Boolean] + attr_accessor :pivot_on_interaction_path + alias_method :pivot_on_interaction_path?, :pivot_on_interaction_path + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @clicks_lookback_window = args[:clicks_lookback_window] if args.key?(:clicks_lookback_window) + @impressions_lookback_window = args[:impressions_lookback_window] if args.key?(:impressions_lookback_window) + @include_attributed_ip_conversions = args[:include_attributed_ip_conversions] if args.key?(:include_attributed_ip_conversions) + @include_unattributed_cookie_conversions = args[:include_unattributed_cookie_conversions] if args.key?(:include_unattributed_cookie_conversions) + @include_unattributed_ip_conversions = args[:include_unattributed_ip_conversions] if args.key?(:include_unattributed_ip_conversions) + @maximum_click_interactions = args[:maximum_click_interactions] if args.key?(:maximum_click_interactions) + @maximum_impression_interactions = args[:maximum_impression_interactions] if args.key?(:maximum_impression_interactions) + @maximum_interaction_gap = args[:maximum_interaction_gap] if args.key?(:maximum_interaction_gap) + @pivot_on_interaction_path = args[:pivot_on_interaction_path] if args.key?(:pivot_on_interaction_path) + end + end + end + + # The report criteria for a report of type "REACH". + class ReachCriteria + include Google::Apis::Core::Hashable + + # Represents an activity group. + # Corresponds to the JSON property `activities` + # @return [Google::Apis::DfareportingV3_0::Activities] + attr_accessor :activities + + # Represents a Custom Rich Media Events group. + # Corresponds to the JSON property `customRichMediaEvents` + # @return [Google::Apis::DfareportingV3_0::CustomRichMediaEvents] + attr_accessor :custom_rich_media_events + + # Represents a date range. + # Corresponds to the JSON property `dateRange` + # @return [Google::Apis::DfareportingV3_0::DateRange] + attr_accessor :date_range + + # The list of filters on which dimensions are filtered. + # Filters for different dimensions are ANDed, filters for the same dimension are + # grouped together and ORed. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # The list of dimensions the report should include. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # Whether to enable all reach dimension combinations in the report. Defaults to + # false. If enabled, the date range of the report should be within the last 42 + # days. + # Corresponds to the JSON property `enableAllDimensionCombinations` + # @return [Boolean] + attr_accessor :enable_all_dimension_combinations + alias_method :enable_all_dimension_combinations?, :enable_all_dimension_combinations + + # The list of names of metrics the report should include. + # Corresponds to the JSON property `metricNames` + # @return [Array] + attr_accessor :metric_names + + # The list of names of Reach By Frequency metrics the report should include. + # Corresponds to the JSON property `reachByFrequencyMetricNames` + # @return [Array] + attr_accessor :reach_by_frequency_metric_names + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @activities = args[:activities] if args.key?(:activities) + @custom_rich_media_events = args[:custom_rich_media_events] if args.key?(:custom_rich_media_events) + @date_range = args[:date_range] if args.key?(:date_range) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @enable_all_dimension_combinations = args[:enable_all_dimension_combinations] if args.key?(:enable_all_dimension_combinations) + @metric_names = args[:metric_names] if args.key?(:metric_names) + @reach_by_frequency_metric_names = args[:reach_by_frequency_metric_names] if args.key?(:reach_by_frequency_metric_names) + end + end + + # The report's schedule. Can only be set if the report's 'dateRange' is a + # relative date range and the relative date range is not "TODAY". + class Schedule + include Google::Apis::Core::Hashable + + # Whether the schedule is active or not. Must be set to either true or false. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Defines every how many days, weeks or months the report should be run. Needs + # to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY". + # Corresponds to the JSON property `every` + # @return [Fixnum] + attr_accessor :every + + # The expiration date when the scheduled report stops running. + # Corresponds to the JSON property `expirationDate` + # @return [Date] + attr_accessor :expiration_date + + # The interval for which the report is repeated. Note: + # - "DAILY" also requires field "every" to be set. + # - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. + # - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set. + # Corresponds to the JSON property `repeats` + # @return [String] + attr_accessor :repeats + + # List of week days "WEEKLY" on which scheduled reports should run. + # Corresponds to the JSON property `repeatsOnWeekDays` + # @return [Array] + attr_accessor :repeats_on_week_days + + # Enum to define for "MONTHLY" scheduled reports whether reports should be + # repeated on the same day of the month as "startDate" or the same day of the + # week of the month. + # Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" + # would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" + # would run subsequent reports on the first Monday of the month. + # Corresponds to the JSON property `runsOnDayOfMonth` + # @return [String] + attr_accessor :runs_on_day_of_month + + # Start date of date range for which scheduled reports should be run. + # Corresponds to the JSON property `startDate` + # @return [Date] + attr_accessor :start_date + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active = args[:active] if args.key?(:active) + @every = args[:every] if args.key?(:every) + @expiration_date = args[:expiration_date] if args.key?(:expiration_date) + @repeats = args[:repeats] if args.key?(:repeats) + @repeats_on_week_days = args[:repeats_on_week_days] if args.key?(:repeats_on_week_days) + @runs_on_day_of_month = args[:runs_on_day_of_month] if args.key?(:runs_on_day_of_month) + @start_date = args[:start_date] if args.key?(:start_date) + end + end + end + + # Represents fields that are compatible to be selected for a report of type " + # STANDARD". + class ReportCompatibleFields + include Google::Apis::Core::Hashable + + # Dimensions which are compatible to be selected in the "dimensionFilters" + # section of the report. + # Corresponds to the JSON property `dimensionFilters` + # @return [Array] + attr_accessor :dimension_filters + + # Dimensions which are compatible to be selected in the "dimensions" section of + # the report. + # Corresponds to the JSON property `dimensions` + # @return [Array] + attr_accessor :dimensions + + # The kind of resource this is, in this case dfareporting#reportCompatibleFields. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Metrics which are compatible to be selected in the "metricNames" section of + # the report. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Metrics which are compatible to be selected as activity metrics to pivot on in + # the "activities" section of the report. + # Corresponds to the JSON property `pivotedActivityMetrics` + # @return [Array] + attr_accessor :pivoted_activity_metrics + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters) + @dimensions = args[:dimensions] if args.key?(:dimensions) + @kind = args[:kind] if args.key?(:kind) + @metrics = args[:metrics] if args.key?(:metrics) + @pivoted_activity_metrics = args[:pivoted_activity_metrics] if args.key?(:pivoted_activity_metrics) + end + end + + # Represents the list of reports. + class ReportList + include Google::Apis::Core::Hashable + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The reports returned in this response. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # The kind of list this is, in this case dfareporting#reportList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Continuation token used to page through reports. To retrieve the next page of + # results, set the next request's "pageToken" to the value of this field. The + # page token is only valid for a limited amount of time and should not be + # persisted. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Reporting Configuration + class ReportsConfiguration + include Google::Apis::Core::Hashable + + # Whether the exposure to conversion report is enabled. This report shows + # detailed pathway information on up to 10 of the most recent ad exposures seen + # by a user before converting. + # Corresponds to the JSON property `exposureToConversionEnabled` + # @return [Boolean] + attr_accessor :exposure_to_conversion_enabled + alias_method :exposure_to_conversion_enabled?, :exposure_to_conversion_enabled + + # Lookback configuration settings. + # Corresponds to the JSON property `lookbackConfiguration` + # @return [Google::Apis::DfareportingV3_0::LookbackConfiguration] + attr_accessor :lookback_configuration + + # Report generation time zone ID of this account. This is a required field that + # can only be changed by a superuser. + # Acceptable values are: + # - "1" for "America/New_York" + # - "2" for "Europe/London" + # - "3" for "Europe/Paris" + # - "4" for "Africa/Johannesburg" + # - "5" for "Asia/Jerusalem" + # - "6" for "Asia/Shanghai" + # - "7" for "Asia/Hong_Kong" + # - "8" for "Asia/Tokyo" + # - "9" for "Australia/Sydney" + # - "10" for "Asia/Dubai" + # - "11" for "America/Los_Angeles" + # - "12" for "Pacific/Auckland" + # - "13" for "America/Sao_Paulo" + # Corresponds to the JSON property `reportGenerationTimeZoneId` + # @return [Fixnum] + attr_accessor :report_generation_time_zone_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @exposure_to_conversion_enabled = args[:exposure_to_conversion_enabled] if args.key?(:exposure_to_conversion_enabled) + @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) + @report_generation_time_zone_id = args[:report_generation_time_zone_id] if args.key?(:report_generation_time_zone_id) + end + end + + # Rich Media Exit Override. + class RichMediaExitOverride + include Google::Apis::Core::Hashable + + # Click-through URL + # Corresponds to the JSON property `clickThroughUrl` + # @return [Google::Apis::DfareportingV3_0::ClickThroughUrl] + attr_accessor :click_through_url + + # Whether to use the clickThroughUrl. If false, the creative-level exit will be + # used. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + # ID for the override to refer to a specific exit in the creative. + # Corresponds to the JSON property `exitId` + # @return [Fixnum] + attr_accessor :exit_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @click_through_url = args[:click_through_url] if args.key?(:click_through_url) + @enabled = args[:enabled] if args.key?(:enabled) + @exit_id = args[:exit_id] if args.key?(:exit_id) + end + end + + # A rule associates an asset with a targeting template for asset-level targeting. + # Applicable to INSTREAM_VIDEO creatives. + class Rule + include Google::Apis::Core::Hashable + + # A creativeAssets[].id. This should refer to one of the parent assets in this + # creative. This is a required field. + # Corresponds to the JSON property `assetId` + # @return [Fixnum] + attr_accessor :asset_id + + # A user-friendly name for this rule. This is a required field. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # A targeting template ID. The targeting from the targeting template will be + # used to determine whether this asset should be served. This is a required + # field. + # Corresponds to the JSON property `targetingTemplateId` + # @return [Fixnum] + attr_accessor :targeting_template_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @asset_id = args[:asset_id] if args.key?(:asset_id) + @name = args[:name] if args.key?(:name) + @targeting_template_id = args[:targeting_template_id] if args.key?(:targeting_template_id) + end + end + + # Contains properties of a site. + class Site + include Google::Apis::Core::Hashable + + # Account ID of this site. This is a read-only field that can be left blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Whether this site is approved. + # Corresponds to the JSON property `approved` + # @return [Boolean] + attr_accessor :approved + alias_method :approved?, :approved + + # Directory site associated with this site. This is a required field that is + # read-only after insertion. + # Corresponds to the JSON property `directorySiteId` + # @return [Fixnum] + attr_accessor :directory_site_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `directorySiteIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :directory_site_id_dimension_value + + # ID of this site. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `idDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :id_dimension_value + + # Key name of this site. This is a read-only, auto-generated field. + # Corresponds to the JSON property `keyName` + # @return [String] + attr_accessor :key_name + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#site". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this site.This is a required field. Must be less than 128 characters + # long. If this site is under a subaccount, the name must be unique among sites + # of the same subaccount. Otherwise, this site is a top-level site, and the name + # must be unique among top-level sites of the same account. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Site contacts. + # Corresponds to the JSON property `siteContacts` + # @return [Array] + attr_accessor :site_contacts + + # Site Settings + # Corresponds to the JSON property `siteSettings` + # @return [Google::Apis::DfareportingV3_0::SiteSettings] + attr_accessor :site_settings + + # Subaccount ID of this site. This is a read-only field that can be left blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @approved = args[:approved] if args.key?(:approved) + @directory_site_id = args[:directory_site_id] if args.key?(:directory_site_id) + @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] if args.key?(:directory_site_id_dimension_value) + @id = args[:id] if args.key?(:id) + @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) + @key_name = args[:key_name] if args.key?(:key_name) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @site_contacts = args[:site_contacts] if args.key?(:site_contacts) + @site_settings = args[:site_settings] if args.key?(:site_settings) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + end + end + + # Site Contact + class SiteContact + include Google::Apis::Core::Hashable + + # Address of this site contact. + # Corresponds to the JSON property `address` + # @return [String] + attr_accessor :address + + # Site contact type. + # Corresponds to the JSON property `contactType` + # @return [String] + attr_accessor :contact_type + + # Email address of this site contact. This is a required field. + # Corresponds to the JSON property `email` + # @return [String] + attr_accessor :email + + # First name of this site contact. + # Corresponds to the JSON property `firstName` + # @return [String] + attr_accessor :first_name + + # ID of this site contact. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Last name of this site contact. + # Corresponds to the JSON property `lastName` + # @return [String] + attr_accessor :last_name + + # Primary phone number of this site contact. + # Corresponds to the JSON property `phone` + # @return [String] + attr_accessor :phone + + # Title or designation of this site contact. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @address = args[:address] if args.key?(:address) + @contact_type = args[:contact_type] if args.key?(:contact_type) + @email = args[:email] if args.key?(:email) + @first_name = args[:first_name] if args.key?(:first_name) + @id = args[:id] if args.key?(:id) + @last_name = args[:last_name] if args.key?(:last_name) + @phone = args[:phone] if args.key?(:phone) + @title = args[:title] if args.key?(:title) + end + end + + # Site Settings + class SiteSettings + include Google::Apis::Core::Hashable + + # Whether active view creatives are disabled for this site. + # Corresponds to the JSON property `activeViewOptOut` + # @return [Boolean] + attr_accessor :active_view_opt_out + alias_method :active_view_opt_out?, :active_view_opt_out + + # Whether this site opts out of ad blocking. When true, ad blocking is disabled + # for all placements under the site, regardless of the individual placement + # settings. When false, the campaign and placement settings take effect. + # Corresponds to the JSON property `adBlockingOptOut` + # @return [Boolean] + attr_accessor :ad_blocking_opt_out + alias_method :ad_blocking_opt_out?, :ad_blocking_opt_out + + # Creative Settings + # Corresponds to the JSON property `creativeSettings` + # @return [Google::Apis::DfareportingV3_0::CreativeSettings] + attr_accessor :creative_settings + + # Whether new cookies are disabled for this site. + # Corresponds to the JSON property `disableNewCookie` + # @return [Boolean] + attr_accessor :disable_new_cookie + alias_method :disable_new_cookie?, :disable_new_cookie + + # Lookback configuration settings. + # Corresponds to the JSON property `lookbackConfiguration` + # @return [Google::Apis::DfareportingV3_0::LookbackConfiguration] + attr_accessor :lookback_configuration + + # Tag Settings + # Corresponds to the JSON property `tagSetting` + # @return [Google::Apis::DfareportingV3_0::TagSetting] + attr_accessor :tag_setting + + # Whether Verification and ActiveView for in-stream video creatives are disabled + # by default for new placements created under this site. This value will be used + # to populate the placement.videoActiveViewOptOut field, when no value is + # specified for the new placement. + # Corresponds to the JSON property `videoActiveViewOptOutTemplate` + # @return [Boolean] + attr_accessor :video_active_view_opt_out_template + alias_method :video_active_view_opt_out_template?, :video_active_view_opt_out_template + + # Default VPAID adapter setting for new placements created under this site. This + # value will be used to populate the placements.vpaidAdapterChoice field, when + # no value is specified for the new placement. Controls which VPAID format the + # measurement adapter will use for in-stream video creatives assigned to the + # placement. The publisher's specifications will typically determine this + # setting. For VPAID creatives, the adapter format will match the VPAID format ( + # HTML5 VPAID creatives use the HTML5 adapter). + # Note: Flash is no longer supported. This field now defaults to HTML5 when the + # following values are provided: FLASH, BOTH. + # Corresponds to the JSON property `vpaidAdapterChoiceTemplate` + # @return [String] + attr_accessor :vpaid_adapter_choice_template + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @active_view_opt_out = args[:active_view_opt_out] if args.key?(:active_view_opt_out) + @ad_blocking_opt_out = args[:ad_blocking_opt_out] if args.key?(:ad_blocking_opt_out) + @creative_settings = args[:creative_settings] if args.key?(:creative_settings) + @disable_new_cookie = args[:disable_new_cookie] if args.key?(:disable_new_cookie) + @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) + @tag_setting = args[:tag_setting] if args.key?(:tag_setting) + @video_active_view_opt_out_template = args[:video_active_view_opt_out_template] if args.key?(:video_active_view_opt_out_template) + @vpaid_adapter_choice_template = args[:vpaid_adapter_choice_template] if args.key?(:vpaid_adapter_choice_template) + end + end + + # Site List Response + class SitesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#sitesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Site collection. + # Corresponds to the JSON property `sites` + # @return [Array] + attr_accessor :sites + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @sites = args[:sites] if args.key?(:sites) + end + end + + # Represents the dimensions of ads, placements, creatives, or creative assets. + class Size + include Google::Apis::Core::Hashable + + # Height of this size. Acceptable values are 0 to 32767, inclusive. + # Corresponds to the JSON property `height` + # @return [Fixnum] + attr_accessor :height + + # IAB standard size. This is a read-only, auto-generated field. + # Corresponds to the JSON property `iab` + # @return [Boolean] + attr_accessor :iab + alias_method :iab?, :iab + + # ID of this size. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#size". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Width of this size. Acceptable values are 0 to 32767, inclusive. + # Corresponds to the JSON property `width` + # @return [Fixnum] + attr_accessor :width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @height = args[:height] if args.key?(:height) + @iab = args[:iab] if args.key?(:iab) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @width = args[:width] if args.key?(:width) + end + end + + # Size List Response + class SizesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#sizesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Size collection. + # Corresponds to the JSON property `sizes` + # @return [Array] + attr_accessor :sizes + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @sizes = args[:sizes] if args.key?(:sizes) + end + end + + # Skippable Settings + class SkippableSetting + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#skippableSetting". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Video Offset + # Corresponds to the JSON property `progressOffset` + # @return [Google::Apis::DfareportingV3_0::VideoOffset] + attr_accessor :progress_offset + + # Video Offset + # Corresponds to the JSON property `skipOffset` + # @return [Google::Apis::DfareportingV3_0::VideoOffset] + attr_accessor :skip_offset + + # Whether the user can skip creatives served to this placement. + # Corresponds to the JSON property `skippable` + # @return [Boolean] + attr_accessor :skippable + alias_method :skippable?, :skippable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @progress_offset = args[:progress_offset] if args.key?(:progress_offset) + @skip_offset = args[:skip_offset] if args.key?(:skip_offset) + @skippable = args[:skippable] if args.key?(:skippable) + end + end + + # Represents a sorted dimension. + class SortedDimension + include Google::Apis::Core::Hashable + + # The kind of resource this is, in this case dfareporting#sortedDimension. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The name of the dimension. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # An optional sort order for the dimension column. + # Corresponds to the JSON property `sortOrder` + # @return [String] + attr_accessor :sort_order + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @sort_order = args[:sort_order] if args.key?(:sort_order) + end + end + + # Contains properties of a DCM subaccount. + class Subaccount + include Google::Apis::Core::Hashable + + # ID of the account that contains this subaccount. This is a read-only field + # that can be left blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # IDs of the available user role permissions for this subaccount. + # Corresponds to the JSON property `availablePermissionIds` + # @return [Array] + attr_accessor :available_permission_ids + + # ID of this subaccount. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#subaccount". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this subaccount. This is a required field. Must be less than 128 + # characters long and be unique among subaccounts of the same account. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @available_permission_ids = args[:available_permission_ids] if args.key?(:available_permission_ids) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # Subaccount List Response + class SubaccountsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#subaccountsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Subaccount collection. + # Corresponds to the JSON property `subaccounts` + # @return [Array] + attr_accessor :subaccounts + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @subaccounts = args[:subaccounts] if args.key?(:subaccounts) + end + end + + # Placement Tag Data + class TagData + include Google::Apis::Core::Hashable + + # Ad associated with this placement tag. Applicable only when format is + # PLACEMENT_TAG_TRACKING. + # Corresponds to the JSON property `adId` + # @return [Fixnum] + attr_accessor :ad_id + + # Tag string to record a click. + # Corresponds to the JSON property `clickTag` + # @return [String] + attr_accessor :click_tag + + # Creative associated with this placement tag. Applicable only when format is + # PLACEMENT_TAG_TRACKING. + # Corresponds to the JSON property `creativeId` + # @return [Fixnum] + attr_accessor :creative_id + + # TagData tag format of this tag. + # Corresponds to the JSON property `format` + # @return [String] + attr_accessor :format + + # Tag string for serving an ad. + # Corresponds to the JSON property `impressionTag` + # @return [String] + attr_accessor :impression_tag + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ad_id = args[:ad_id] if args.key?(:ad_id) + @click_tag = args[:click_tag] if args.key?(:click_tag) + @creative_id = args[:creative_id] if args.key?(:creative_id) + @format = args[:format] if args.key?(:format) + @impression_tag = args[:impression_tag] if args.key?(:impression_tag) + end + end + + # Tag Settings + class TagSetting + include Google::Apis::Core::Hashable + + # Additional key-values to be included in tags. Each key-value pair must be of + # the form key=value, and pairs must be separated by a semicolon (;). Keys and + # values must not contain commas. For example, id=2;color=red is a valid value + # for this field. + # Corresponds to the JSON property `additionalKeyValues` + # @return [String] + attr_accessor :additional_key_values + + # Whether static landing page URLs should be included in the tags. This setting + # applies only to placements. + # Corresponds to the JSON property `includeClickThroughUrls` + # @return [Boolean] + attr_accessor :include_click_through_urls + alias_method :include_click_through_urls?, :include_click_through_urls + + # Whether click-tracking string should be included in the tags. + # Corresponds to the JSON property `includeClickTracking` + # @return [Boolean] + attr_accessor :include_click_tracking + alias_method :include_click_tracking?, :include_click_tracking + + # Option specifying how keywords are embedded in ad tags. This setting can be + # used to specify whether keyword placeholders are inserted in placement tags + # for this site. Publishers can then add keywords to those placeholders. + # Corresponds to the JSON property `keywordOption` + # @return [String] + attr_accessor :keyword_option + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @additional_key_values = args[:additional_key_values] if args.key?(:additional_key_values) + @include_click_through_urls = args[:include_click_through_urls] if args.key?(:include_click_through_urls) + @include_click_tracking = args[:include_click_tracking] if args.key?(:include_click_tracking) + @keyword_option = args[:keyword_option] if args.key?(:keyword_option) + end + end + + # Dynamic and Image Tag Settings. + class TagSettings + include Google::Apis::Core::Hashable + + # Whether dynamic floodlight tags are enabled. + # Corresponds to the JSON property `dynamicTagEnabled` + # @return [Boolean] + attr_accessor :dynamic_tag_enabled + alias_method :dynamic_tag_enabled?, :dynamic_tag_enabled + + # Whether image tags are enabled. + # Corresponds to the JSON property `imageTagEnabled` + # @return [Boolean] + attr_accessor :image_tag_enabled + alias_method :image_tag_enabled?, :image_tag_enabled + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dynamic_tag_enabled = args[:dynamic_tag_enabled] if args.key?(:dynamic_tag_enabled) + @image_tag_enabled = args[:image_tag_enabled] if args.key?(:image_tag_enabled) + end + end + + # Target Window. + class TargetWindow + include Google::Apis::Core::Hashable + + # User-entered value. + # Corresponds to the JSON property `customHtml` + # @return [String] + attr_accessor :custom_html + + # Type of browser window for which the backup image of the flash creative can be + # displayed. + # Corresponds to the JSON property `targetWindowOption` + # @return [String] + attr_accessor :target_window_option + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_html = args[:custom_html] if args.key?(:custom_html) + @target_window_option = args[:target_window_option] if args.key?(:target_window_option) + end + end + + # Contains properties of a targetable remarketing list. Remarketing enables you + # to create lists of users who have performed specific actions on a site, then + # target ads to members of those lists. This resource is a read-only view of a + # remarketing list to be used to faciliate targeting ads to specific lists. + # Remarketing lists that are owned by your advertisers and those that are shared + # to your advertisers or account are accessible via this resource. To manage + # remarketing lists that are owned by your advertisers, use the RemarketingLists + # resource. + class TargetableRemarketingList + include Google::Apis::Core::Hashable + + # Account ID of this remarketing list. This is a read-only, auto-generated field + # that is only returned in GET requests. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Whether this targetable remarketing list is active. + # Corresponds to the JSON property `active` + # @return [Boolean] + attr_accessor :active + alias_method :active?, :active + + # Dimension value for the advertiser ID that owns this targetable remarketing + # list. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Targetable remarketing list description. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Targetable remarketing list ID. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#targetableRemarketingList". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Number of days that a user should remain in the targetable remarketing list + # without an impression. + # Corresponds to the JSON property `lifeSpan` + # @return [Fixnum] + attr_accessor :life_span + + # Number of users currently in the list. This is a read-only field. + # Corresponds to the JSON property `listSize` + # @return [Fixnum] + attr_accessor :list_size + + # Product from which this targetable remarketing list was originated. + # Corresponds to the JSON property `listSource` + # @return [String] + attr_accessor :list_source + + # Name of the targetable remarketing list. Is no greater than 128 characters + # long. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Subaccount ID of this remarketing list. This is a read-only, auto-generated + # field that is only returned in GET requests. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @active = args[:active] if args.key?(:active) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @description = args[:description] if args.key?(:description) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @life_span = args[:life_span] if args.key?(:life_span) + @list_size = args[:list_size] if args.key?(:list_size) + @list_source = args[:list_source] if args.key?(:list_source) + @name = args[:name] if args.key?(:name) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + end + end + + # Targetable remarketing list response + class TargetableRemarketingListsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#targetableRemarketingListsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Targetable remarketing list collection. + # Corresponds to the JSON property `targetableRemarketingLists` + # @return [Array] + attr_accessor :targetable_remarketing_lists + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @targetable_remarketing_lists = args[:targetable_remarketing_lists] if args.key?(:targetable_remarketing_lists) + end + end + + # Contains properties of a targeting template. A targeting template encapsulates + # targeting information which can be reused across multiple ads. + class TargetingTemplate + include Google::Apis::Core::Hashable + + # Account ID of this targeting template. This field, if left unset, will be auto- + # generated on insert and is read-only after insert. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Advertiser ID of this targeting template. This is a required field on insert + # and is read-only after insert. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Represents a DimensionValue resource. + # Corresponds to the JSON property `advertiserIdDimensionValue` + # @return [Google::Apis::DfareportingV3_0::DimensionValue] + attr_accessor :advertiser_id_dimension_value + + # Day Part Targeting. + # Corresponds to the JSON property `dayPartTargeting` + # @return [Google::Apis::DfareportingV3_0::DayPartTargeting] + attr_accessor :day_part_targeting + + # Geographical Targeting. + # Corresponds to the JSON property `geoTargeting` + # @return [Google::Apis::DfareportingV3_0::GeoTargeting] + attr_accessor :geo_targeting + + # ID of this targeting template. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Key Value Targeting Expression. + # Corresponds to the JSON property `keyValueTargetingExpression` + # @return [Google::Apis::DfareportingV3_0::KeyValueTargetingExpression] + attr_accessor :key_value_targeting_expression + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#targetingTemplate". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Language Targeting. + # Corresponds to the JSON property `languageTargeting` + # @return [Google::Apis::DfareportingV3_0::LanguageTargeting] + attr_accessor :language_targeting + + # Remarketing List Targeting Expression. + # Corresponds to the JSON property `listTargetingExpression` + # @return [Google::Apis::DfareportingV3_0::ListTargetingExpression] + attr_accessor :list_targeting_expression + + # Name of this targeting template. This field is required. It must be less than + # 256 characters long and unique within an advertiser. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Subaccount ID of this targeting template. This field, if left unset, will be + # auto-generated on insert and is read-only after insert. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + # Technology Targeting. + # Corresponds to the JSON property `technologyTargeting` + # @return [Google::Apis::DfareportingV3_0::TechnologyTargeting] + attr_accessor :technology_targeting + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) + @day_part_targeting = args[:day_part_targeting] if args.key?(:day_part_targeting) + @geo_targeting = args[:geo_targeting] if args.key?(:geo_targeting) + @id = args[:id] if args.key?(:id) + @key_value_targeting_expression = args[:key_value_targeting_expression] if args.key?(:key_value_targeting_expression) + @kind = args[:kind] if args.key?(:kind) + @language_targeting = args[:language_targeting] if args.key?(:language_targeting) + @list_targeting_expression = args[:list_targeting_expression] if args.key?(:list_targeting_expression) + @name = args[:name] if args.key?(:name) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + @technology_targeting = args[:technology_targeting] if args.key?(:technology_targeting) + end + end + + # Targeting Template List Response + class TargetingTemplatesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#targetingTemplatesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Targeting template collection. + # Corresponds to the JSON property `targetingTemplates` + # @return [Array] + attr_accessor :targeting_templates + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @targeting_templates = args[:targeting_templates] if args.key?(:targeting_templates) + end + end + + # Technology Targeting. + class TechnologyTargeting + include Google::Apis::Core::Hashable + + # Browsers that this ad targets. For each browser either set browserVersionId or + # dartId along with the version numbers. If both are specified, only + # browserVersionId will be used. The other fields are populated automatically + # when the ad is inserted or updated. + # Corresponds to the JSON property `browsers` + # @return [Array] + attr_accessor :browsers + + # Connection types that this ad targets. For each connection type only id is + # required. The other fields are populated automatically when the ad is inserted + # or updated. + # Corresponds to the JSON property `connectionTypes` + # @return [Array] + attr_accessor :connection_types + + # Mobile carriers that this ad targets. For each mobile carrier only id is + # required, and the other fields are populated automatically when the ad is + # inserted or updated. If targeting a mobile carrier, do not set targeting for + # any zip codes. + # Corresponds to the JSON property `mobileCarriers` + # @return [Array] + attr_accessor :mobile_carriers + + # Operating system versions that this ad targets. To target all versions, use + # operatingSystems. For each operating system version, only id is required. The + # other fields are populated automatically when the ad is inserted or updated. + # If targeting an operating system version, do not set targeting for the + # corresponding operating system in operatingSystems. + # Corresponds to the JSON property `operatingSystemVersions` + # @return [Array] + attr_accessor :operating_system_versions + + # Operating systems that this ad targets. To target specific versions, use + # operatingSystemVersions. For each operating system only dartId is required. + # The other fields are populated automatically when the ad is inserted or + # updated. If targeting an operating system, do not set targeting for operating + # system versions for the same operating system. + # Corresponds to the JSON property `operatingSystems` + # @return [Array] + attr_accessor :operating_systems + + # Platform types that this ad targets. For example, desktop, mobile, or tablet. + # For each platform type, only id is required, and the other fields are + # populated automatically when the ad is inserted or updated. + # Corresponds to the JSON property `platformTypes` + # @return [Array] + attr_accessor :platform_types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @browsers = args[:browsers] if args.key?(:browsers) + @connection_types = args[:connection_types] if args.key?(:connection_types) + @mobile_carriers = args[:mobile_carriers] if args.key?(:mobile_carriers) + @operating_system_versions = args[:operating_system_versions] if args.key?(:operating_system_versions) + @operating_systems = args[:operating_systems] if args.key?(:operating_systems) + @platform_types = args[:platform_types] if args.key?(:platform_types) + end + end + + # Third Party Authentication Token + class ThirdPartyAuthenticationToken + include Google::Apis::Core::Hashable + + # Name of the third-party authentication token. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Value of the third-party authentication token. This is a read-only, auto- + # generated field. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @value = args[:value] if args.key?(:value) + end + end + + # Third-party Tracking URL. + class ThirdPartyTrackingUrl + include Google::Apis::Core::Hashable + + # Third-party URL type for in-stream video creatives. + # Corresponds to the JSON property `thirdPartyUrlType` + # @return [String] + attr_accessor :third_party_url_type + + # URL for the specified third-party URL type. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @third_party_url_type = args[:third_party_url_type] if args.key?(:third_party_url_type) + @url = args[:url] if args.key?(:url) + end + end + + # Transcode Settings + class TranscodeSetting + include Google::Apis::Core::Hashable + + # Whitelist of video formats to be served to this placement. Set this list to + # null or empty to serve all video formats. + # Corresponds to the JSON property `enabledVideoFormats` + # @return [Array] + attr_accessor :enabled_video_formats + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#transcodeSetting". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enabled_video_formats = args[:enabled_video_formats] if args.key?(:enabled_video_formats) + @kind = args[:kind] if args.key?(:kind) + end + end + + # A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following + # creative types: INSTREAM_VIDEO and VPAID. + class UniversalAdId + include Google::Apis::Core::Hashable + + # Registry used for the Ad ID value. + # Corresponds to the JSON property `registry` + # @return [String] + attr_accessor :registry + + # ID value for this creative. Only alphanumeric characters and the following + # symbols are valid: "_/\-". Maximum length is 64 characters. Read only when + # registry is DCM. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @registry = args[:registry] if args.key?(:registry) + @value = args[:value] if args.key?(:value) + end + end + + # User Defined Variable configuration. + class UserDefinedVariableConfiguration + include Google::Apis::Core::Hashable + + # Data type for the variable. This is a required field. + # Corresponds to the JSON property `dataType` + # @return [String] + attr_accessor :data_type + + # User-friendly name for the variable which will appear in reports. This is a + # required field, must be less than 64 characters long, and cannot contain the + # following characters: ""<>". + # Corresponds to the JSON property `reportName` + # @return [String] + attr_accessor :report_name + + # Variable name in the tag. This is a required field. + # Corresponds to the JSON property `variableType` + # @return [String] + attr_accessor :variable_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @data_type = args[:data_type] if args.key?(:data_type) + @report_name = args[:report_name] if args.key?(:report_name) + @variable_type = args[:variable_type] if args.key?(:variable_type) + end + end + + # Represents a UserProfile resource. + class UserProfile + include Google::Apis::Core::Hashable + + # The account ID to which this profile belongs. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # The account name this profile belongs to. + # Corresponds to the JSON property `accountName` + # @return [String] + attr_accessor :account_name + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The kind of resource this is, in this case dfareporting#userProfile. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The unique ID of the user profile. + # Corresponds to the JSON property `profileId` + # @return [Fixnum] + attr_accessor :profile_id + + # The sub account ID this profile belongs to if applicable. + # Corresponds to the JSON property `subAccountId` + # @return [Fixnum] + attr_accessor :sub_account_id + + # The sub account name this profile belongs to if applicable. + # Corresponds to the JSON property `subAccountName` + # @return [String] + attr_accessor :sub_account_name + + # The user name. + # Corresponds to the JSON property `userName` + # @return [String] + attr_accessor :user_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @account_name = args[:account_name] if args.key?(:account_name) + @etag = args[:etag] if args.key?(:etag) + @kind = args[:kind] if args.key?(:kind) + @profile_id = args[:profile_id] if args.key?(:profile_id) + @sub_account_id = args[:sub_account_id] if args.key?(:sub_account_id) + @sub_account_name = args[:sub_account_name] if args.key?(:sub_account_name) + @user_name = args[:user_name] if args.key?(:user_name) + end + end + + # Represents the list of user profiles. + class UserProfileList + include Google::Apis::Core::Hashable + + # The eTag of this response for caching purposes. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # The user profiles returned in this response. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # The kind of list this is, in this case dfareporting#userProfileList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + end + end + + # Contains properties of auser role, which is used to manage user access. + class UserRole + include Google::Apis::Core::Hashable + + # Account ID of this user role. This is a read-only field that can be left blank. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Whether this is a default user role. Default user roles are created by the + # system for the account/subaccount and cannot be modified or deleted. Each + # default user role comes with a basic set of preassigned permissions. + # Corresponds to the JSON property `defaultUserRole` + # @return [Boolean] + attr_accessor :default_user_role + alias_method :default_user_role?, :default_user_role + + # ID of this user role. This is a read-only, auto-generated field. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userRole". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this user role. This is a required field. Must be less than 256 + # characters long. If this user role is under a subaccount, the name must be + # unique among sites of the same subaccount. Otherwise, this user role is a top- + # level user role, and the name must be unique among top-level user roles of the + # same account. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # ID of the user role that this user role is based on or copied from. This is a + # required field. + # Corresponds to the JSON property `parentUserRoleId` + # @return [Fixnum] + attr_accessor :parent_user_role_id + + # List of permissions associated with this user role. + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + # Subaccount ID of this user role. This is a read-only field that can be left + # blank. + # Corresponds to the JSON property `subaccountId` + # @return [Fixnum] + attr_accessor :subaccount_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @default_user_role = args[:default_user_role] if args.key?(:default_user_role) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @parent_user_role_id = args[:parent_user_role_id] if args.key?(:parent_user_role_id) + @permissions = args[:permissions] if args.key?(:permissions) + @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) + end + end + + # Contains properties of a user role permission. + class UserRolePermission + include Google::Apis::Core::Hashable + + # Levels of availability for a user role permission. + # Corresponds to the JSON property `availability` + # @return [String] + attr_accessor :availability + + # ID of this user role permission. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userRolePermission". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this user role permission. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # ID of the permission group that this user role permission belongs to. + # Corresponds to the JSON property `permissionGroupId` + # @return [Fixnum] + attr_accessor :permission_group_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @availability = args[:availability] if args.key?(:availability) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @permission_group_id = args[:permission_group_id] if args.key?(:permission_group_id) + end + end + + # Represents a grouping of related user role permissions. + class UserRolePermissionGroup + include Google::Apis::Core::Hashable + + # ID of this user role permission. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userRolePermissionGroup". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Name of this user role permission group. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # User Role Permission Group List Response + class UserRolePermissionGroupsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userRolePermissionGroupsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # User role permission group collection. + # Corresponds to the JSON property `userRolePermissionGroups` + # @return [Array] + attr_accessor :user_role_permission_groups + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @user_role_permission_groups = args[:user_role_permission_groups] if args.key?(:user_role_permission_groups) + end + end + + # User Role Permission List Response + class UserRolePermissionsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userRolePermissionsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # User role permission collection. + # Corresponds to the JSON property `userRolePermissions` + # @return [Array] + attr_accessor :user_role_permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @user_role_permissions = args[:user_role_permissions] if args.key?(:user_role_permissions) + end + end + + # User Role List Response + class UserRolesListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#userRolesListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Pagination token to be used for the next list operation. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # User role collection. + # Corresponds to the JSON property `userRoles` + # @return [Array] + attr_accessor :user_roles + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @user_roles = args[:user_roles] if args.key?(:user_roles) + end + end + + # Contains information about supported video formats. + class VideoFormat + include Google::Apis::Core::Hashable + + # File type of the video format. + # Corresponds to the JSON property `fileType` + # @return [String] + attr_accessor :file_type + + # ID of the video format. + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#videoFormat". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Represents the dimensions of ads, placements, creatives, or creative assets. + # Corresponds to the JSON property `resolution` + # @return [Google::Apis::DfareportingV3_0::Size] + attr_accessor :resolution + + # The target bit rate of this video format. + # Corresponds to the JSON property `targetBitRate` + # @return [Fixnum] + attr_accessor :target_bit_rate + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @file_type = args[:file_type] if args.key?(:file_type) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @resolution = args[:resolution] if args.key?(:resolution) + @target_bit_rate = args[:target_bit_rate] if args.key?(:target_bit_rate) + end + end + + # Video Format List Response + class VideoFormatsListResponse + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#videoFormatsListResponse". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Video format collection. + # Corresponds to the JSON property `videoFormats` + # @return [Array] + attr_accessor :video_formats + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @video_formats = args[:video_formats] if args.key?(:video_formats) + end + end + + # Video Offset + class VideoOffset + include Google::Apis::Core::Hashable + + # Duration, as a percentage of video duration. Do not set when offsetSeconds is + # set. Acceptable values are 0 to 100, inclusive. + # Corresponds to the JSON property `offsetPercentage` + # @return [Fixnum] + attr_accessor :offset_percentage + + # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable + # values are 0 to 86399, inclusive. + # Corresponds to the JSON property `offsetSeconds` + # @return [Fixnum] + attr_accessor :offset_seconds + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @offset_percentage = args[:offset_percentage] if args.key?(:offset_percentage) + @offset_seconds = args[:offset_seconds] if args.key?(:offset_seconds) + end + end + + # Video Settings + class VideoSettings + include Google::Apis::Core::Hashable + + # Companion Settings + # Corresponds to the JSON property `companionSettings` + # @return [Google::Apis::DfareportingV3_0::CompanionSetting] + attr_accessor :companion_settings + + # Identifies what kind of resource this is. Value: the fixed string " + # dfareporting#videoSettings". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Orientation of a video placement. If this value is set, placement will return + # assets matching the specified orientation. + # Corresponds to the JSON property `orientation` + # @return [String] + attr_accessor :orientation + + # Skippable Settings + # Corresponds to the JSON property `skippableSettings` + # @return [Google::Apis::DfareportingV3_0::SkippableSetting] + attr_accessor :skippable_settings + + # Transcode Settings + # Corresponds to the JSON property `transcodeSettings` + # @return [Google::Apis::DfareportingV3_0::TranscodeSetting] + attr_accessor :transcode_settings + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @companion_settings = args[:companion_settings] if args.key?(:companion_settings) + @kind = args[:kind] if args.key?(:kind) + @orientation = args[:orientation] if args.key?(:orientation) + @skippable_settings = args[:skippable_settings] if args.key?(:skippable_settings) + @transcode_settings = args[:transcode_settings] if args.key?(:transcode_settings) + end + end + end + end +end diff --git a/generated/google/apis/dfareporting_v3_0/representations.rb b/generated/google/apis/dfareporting_v3_0/representations.rb new file mode 100644 index 000000000..00e941868 --- /dev/null +++ b/generated/google/apis/dfareporting_v3_0/representations.rb @@ -0,0 +1,4336 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DfareportingV3_0 + + class Account + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountActiveAdSummary + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountPermission + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountPermissionGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountPermissionGroupsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountPermissionsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountUserProfile + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountUserProfilesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AccountsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Activities + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Ad + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdBlockingConfiguration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdSlot + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Advertiser + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdvertiserGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdvertiserGroupsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdvertiserLandingPagesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AdvertisersListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AudienceSegment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AudienceSegmentGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Browser + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BrowsersListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Campaign + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CampaignCreativeAssociation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CampaignCreativeAssociationsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CampaignsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ChangeLog + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ChangeLogsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CitiesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class City + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ClickTag + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ClickThroughUrl + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ClickThroughUrlSuffixProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CompanionClickThroughOverride + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CompanionSetting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CompatibleFields + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConnectionType + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConnectionTypesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ContentCategoriesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ContentCategory + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Conversion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConversionError + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConversionStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConversionsBatchInsertRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConversionsBatchInsertResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConversionsBatchUpdateRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ConversionsBatchUpdateResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CountriesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Country + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Creative + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeAsset + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeAssetId + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeAssetMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeAssetSelection + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeAssignment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeClickThroughUrl + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeCustomEvent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeField + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeFieldAssignment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeFieldValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeFieldValuesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeFieldsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeGroupAssignment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeGroupsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeOptimizationConfiguration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeRotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativeSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreativesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CrossDimensionReachReportCompatibleFields + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomFloodlightVariable + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomRichMediaEvents + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DateRange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DayPartTargeting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DefaultClickThroughEventTagProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeliverySchedule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DfpSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Dimension + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DimensionFilter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DimensionValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DimensionValueList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DimensionValueRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DirectorySite + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DirectorySiteContact + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DirectorySiteContactAssignment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DirectorySiteContactsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DirectorySiteSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DirectorySitesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DynamicTargetingKey + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DynamicTargetingKeysListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EncryptionInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EventTag + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EventTagOverride + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EventTagsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class File + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Urls + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class FileList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Flight + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightActivitiesGenerateTagResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightActivitiesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightActivity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightActivityDynamicTag + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightActivityGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightActivityGroupsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightActivityPublisherDynamicTag + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightConfiguration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightConfigurationsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightReportCompatibleFields + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FrequencyCap + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FsCommand + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GeoTargeting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InventoryItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InventoryItemsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class KeyValueTargetingExpression + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LandingPage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Language + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LanguageTargeting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LanguagesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LastModifiedInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListPopulationClause + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListPopulationRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListPopulationTerm + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListTargetingExpression + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LookbackConfiguration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Metric + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Metro + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MetrosListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MobileCarrier + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MobileCarriersListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ObjectFilter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OffsetPosition + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OmnitureSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperatingSystem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperatingSystemVersion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperatingSystemVersionsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperatingSystemsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OptimizationActivity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Order + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrderContact + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrderDocument + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrderDocumentsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OrdersListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PathToConversionReportCompatibleFields + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Placement + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementAssignment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementGroupsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementStrategiesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementStrategy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementTag + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementsGenerateTagsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlacementsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlatformType + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PlatformTypesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PopupWindowProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PostalCode + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PostalCodesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Pricing + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PricingSchedule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PricingSchedulePricingPeriod + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Project + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ProjectsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReachReportCompatibleFields + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Recipient + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Region + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RegionsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RemarketingList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RemarketingListShare + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RemarketingListsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Report + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Criteria + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CrossDimensionReachCriteria + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Delivery + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FloodlightCriteria + class Representation < Google::Apis::Core::JsonRepresentation; end + + class ReportProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class PathToConversionCriteria + class Representation < Google::Apis::Core::JsonRepresentation; end + + class ReportProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReachCriteria + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Schedule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReportCompatibleFields + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReportList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReportsConfiguration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RichMediaExitOverride + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Rule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Site + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SiteContact + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SiteSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SitesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Size + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SizesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SkippableSetting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SortedDimension + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Subaccount + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SubaccountsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TagData + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TagSetting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TagSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetWindow + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetableRemarketingList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetableRemarketingListsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetingTemplate + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TargetingTemplatesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TechnologyTargeting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ThirdPartyAuthenticationToken + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ThirdPartyTrackingUrl + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TranscodeSetting + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UniversalAdId + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserDefinedVariableConfiguration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserProfile + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserProfileList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserRole + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserRolePermission + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserRolePermissionGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserRolePermissionGroupsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserRolePermissionsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UserRolesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class VideoFormat + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class VideoFormatsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class VideoOffset + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class VideoSettings + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Account + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :account_permission_ids, as: 'accountPermissionIds' + property :account_profile, as: 'accountProfile' + property :active, as: 'active' + property :active_ads_limit_tier, as: 'activeAdsLimitTier' + property :active_view_opt_out, as: 'activeViewOptOut' + collection :available_permission_ids, as: 'availablePermissionIds' + property :country_id, :numeric_string => true, as: 'countryId' + property :currency_id, :numeric_string => true, as: 'currencyId' + property :default_creative_size_id, :numeric_string => true, as: 'defaultCreativeSizeId' + property :description, as: 'description' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :locale, as: 'locale' + property :maximum_image_size, :numeric_string => true, as: 'maximumImageSize' + property :name, as: 'name' + property :nielsen_ocr_enabled, as: 'nielsenOcrEnabled' + property :reports_configuration, as: 'reportsConfiguration', class: Google::Apis::DfareportingV3_0::ReportsConfiguration, decorator: Google::Apis::DfareportingV3_0::ReportsConfiguration::Representation + + property :share_reports_with_twitter, as: 'shareReportsWithTwitter' + property :teaser_size_limit, :numeric_string => true, as: 'teaserSizeLimit' + end + end + + class AccountActiveAdSummary + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :active_ads, :numeric_string => true, as: 'activeAds' + property :active_ads_limit_tier, as: 'activeAdsLimitTier' + property :available_ads, :numeric_string => true, as: 'availableAds' + property :kind, as: 'kind' + end + end + + class AccountPermission + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :account_profiles, as: 'accountProfiles' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :level, as: 'level' + property :name, as: 'name' + property :permission_group_id, :numeric_string => true, as: 'permissionGroupId' + end + end + + class AccountPermissionGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class AccountPermissionGroupsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :account_permission_groups, as: 'accountPermissionGroups', class: Google::Apis::DfareportingV3_0::AccountPermissionGroup, decorator: Google::Apis::DfareportingV3_0::AccountPermissionGroup::Representation + + property :kind, as: 'kind' + end + end + + class AccountPermissionsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :account_permissions, as: 'accountPermissions', class: Google::Apis::DfareportingV3_0::AccountPermission, decorator: Google::Apis::DfareportingV3_0::AccountPermission::Representation + + property :kind, as: 'kind' + end + end + + class AccountUserProfile + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :active, as: 'active' + property :advertiser_filter, as: 'advertiserFilter', class: Google::Apis::DfareportingV3_0::ObjectFilter, decorator: Google::Apis::DfareportingV3_0::ObjectFilter::Representation + + property :campaign_filter, as: 'campaignFilter', class: Google::Apis::DfareportingV3_0::ObjectFilter, decorator: Google::Apis::DfareportingV3_0::ObjectFilter::Representation + + property :comments, as: 'comments' + property :email, as: 'email' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :locale, as: 'locale' + property :name, as: 'name' + property :site_filter, as: 'siteFilter', class: Google::Apis::DfareportingV3_0::ObjectFilter, decorator: Google::Apis::DfareportingV3_0::ObjectFilter::Representation + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :trafficker_type, as: 'traffickerType' + property :user_access_type, as: 'userAccessType' + property :user_role_filter, as: 'userRoleFilter', class: Google::Apis::DfareportingV3_0::ObjectFilter, decorator: Google::Apis::DfareportingV3_0::ObjectFilter::Representation + + property :user_role_id, :numeric_string => true, as: 'userRoleId' + end + end + + class AccountUserProfilesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :account_user_profiles, as: 'accountUserProfiles', class: Google::Apis::DfareportingV3_0::AccountUserProfile, decorator: Google::Apis::DfareportingV3_0::AccountUserProfile::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class AccountsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :accounts, as: 'accounts', class: Google::Apis::DfareportingV3_0::Account, decorator: Google::Apis::DfareportingV3_0::Account::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class Activities + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :filters, as: 'filters', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :kind, as: 'kind' + collection :metric_names, as: 'metricNames' + end + end + + class Ad + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :active, as: 'active' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :archived, as: 'archived' + property :audience_segment_id, :numeric_string => true, as: 'audienceSegmentId' + property :campaign_id, :numeric_string => true, as: 'campaignId' + property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV3_0::ClickThroughUrl, decorator: Google::Apis::DfareportingV3_0::ClickThroughUrl::Representation + + property :click_through_url_suffix_properties, as: 'clickThroughUrlSuffixProperties', class: Google::Apis::DfareportingV3_0::ClickThroughUrlSuffixProperties, decorator: Google::Apis::DfareportingV3_0::ClickThroughUrlSuffixProperties::Representation + + property :comments, as: 'comments' + property :compatibility, as: 'compatibility' + property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation + + collection :creative_group_assignments, as: 'creativeGroupAssignments', class: Google::Apis::DfareportingV3_0::CreativeGroupAssignment, decorator: Google::Apis::DfareportingV3_0::CreativeGroupAssignment::Representation + + property :creative_rotation, as: 'creativeRotation', class: Google::Apis::DfareportingV3_0::CreativeRotation, decorator: Google::Apis::DfareportingV3_0::CreativeRotation::Representation + + property :day_part_targeting, as: 'dayPartTargeting', class: Google::Apis::DfareportingV3_0::DayPartTargeting, decorator: Google::Apis::DfareportingV3_0::DayPartTargeting::Representation + + property :default_click_through_event_tag_properties, as: 'defaultClickThroughEventTagProperties', class: Google::Apis::DfareportingV3_0::DefaultClickThroughEventTagProperties, decorator: Google::Apis::DfareportingV3_0::DefaultClickThroughEventTagProperties::Representation + + property :delivery_schedule, as: 'deliverySchedule', class: Google::Apis::DfareportingV3_0::DeliverySchedule, decorator: Google::Apis::DfareportingV3_0::DeliverySchedule::Representation + + property :dynamic_click_tracker, as: 'dynamicClickTracker' + property :end_time, as: 'endTime', type: DateTime + + collection :event_tag_overrides, as: 'eventTagOverrides', class: Google::Apis::DfareportingV3_0::EventTagOverride, decorator: Google::Apis::DfareportingV3_0::EventTagOverride::Representation + + property :geo_targeting, as: 'geoTargeting', class: Google::Apis::DfareportingV3_0::GeoTargeting, decorator: Google::Apis::DfareportingV3_0::GeoTargeting::Representation + + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :key_value_targeting_expression, as: 'keyValueTargetingExpression', class: Google::Apis::DfareportingV3_0::KeyValueTargetingExpression, decorator: Google::Apis::DfareportingV3_0::KeyValueTargetingExpression::Representation + + property :kind, as: 'kind' + property :language_targeting, as: 'languageTargeting', class: Google::Apis::DfareportingV3_0::LanguageTargeting, decorator: Google::Apis::DfareportingV3_0::LanguageTargeting::Representation + + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation + + property :name, as: 'name' + collection :placement_assignments, as: 'placementAssignments', class: Google::Apis::DfareportingV3_0::PlacementAssignment, decorator: Google::Apis::DfareportingV3_0::PlacementAssignment::Representation + + property :remarketing_list_expression, as: 'remarketingListExpression', class: Google::Apis::DfareportingV3_0::ListTargetingExpression, decorator: Google::Apis::DfareportingV3_0::ListTargetingExpression::Representation + + property :size, as: 'size', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation + + property :ssl_compliant, as: 'sslCompliant' + property :ssl_required, as: 'sslRequired' + property :start_time, as: 'startTime', type: DateTime + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :targeting_template_id, :numeric_string => true, as: 'targetingTemplateId' + property :technology_targeting, as: 'technologyTargeting', class: Google::Apis::DfareportingV3_0::TechnologyTargeting, decorator: Google::Apis::DfareportingV3_0::TechnologyTargeting::Representation + + property :type, as: 'type' + end + end + + class AdBlockingConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_through_url, as: 'clickThroughUrl' + property :creative_bundle_id, :numeric_string => true, as: 'creativeBundleId' + property :enabled, as: 'enabled' + property :override_click_through_url, as: 'overrideClickThroughUrl' + end + end + + class AdSlot + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :comment, as: 'comment' + property :compatibility, as: 'compatibility' + property :height, :numeric_string => true, as: 'height' + property :linked_placement_id, :numeric_string => true, as: 'linkedPlacementId' + property :name, as: 'name' + property :payment_source_type, as: 'paymentSourceType' + property :primary, as: 'primary' + property :width, :numeric_string => true, as: 'width' + end + end + + class AdsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :ads, as: 'ads', class: Google::Apis::DfareportingV3_0::Ad, decorator: Google::Apis::DfareportingV3_0::Ad::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class Advertiser + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_group_id, :numeric_string => true, as: 'advertiserGroupId' + property :click_through_url_suffix, as: 'clickThroughUrlSuffix' + property :default_click_through_event_tag_id, :numeric_string => true, as: 'defaultClickThroughEventTagId' + property :default_email, as: 'defaultEmail' + property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' + property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :kind, as: 'kind' + property :name, as: 'name' + property :original_floodlight_configuration_id, :numeric_string => true, as: 'originalFloodlightConfigurationId' + property :status, as: 'status' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :suspended, as: 'suspended' + end + end + + class AdvertiserGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class AdvertiserGroupsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :advertiser_groups, as: 'advertiserGroups', class: Google::Apis::DfareportingV3_0::AdvertiserGroup, decorator: Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class AdvertiserLandingPagesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :landing_pages, as: 'landingPages', class: Google::Apis::DfareportingV3_0::LandingPage, decorator: Google::Apis::DfareportingV3_0::LandingPage::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class AdvertisersListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :advertisers, as: 'advertisers', class: Google::Apis::DfareportingV3_0::Advertiser, decorator: Google::Apis::DfareportingV3_0::Advertiser::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class AudienceSegment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allocation, as: 'allocation' + property :id, :numeric_string => true, as: 'id' + property :name, as: 'name' + end + end + + class AudienceSegmentGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audience_segments, as: 'audienceSegments', class: Google::Apis::DfareportingV3_0::AudienceSegment, decorator: Google::Apis::DfareportingV3_0::AudienceSegment::Representation + + property :id, :numeric_string => true, as: 'id' + property :name, as: 'name' + end + end + + class Browser + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :browser_version_id, :numeric_string => true, as: 'browserVersionId' + property :dart_id, :numeric_string => true, as: 'dartId' + property :kind, as: 'kind' + property :major_version, as: 'majorVersion' + property :minor_version, as: 'minorVersion' + property :name, as: 'name' + end + end + + class BrowsersListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :browsers, as: 'browsers', class: Google::Apis::DfareportingV3_0::Browser, decorator: Google::Apis::DfareportingV3_0::Browser::Representation + + property :kind, as: 'kind' + end + end + + class Campaign + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :ad_blocking_configuration, as: 'adBlockingConfiguration', class: Google::Apis::DfareportingV3_0::AdBlockingConfiguration, decorator: Google::Apis::DfareportingV3_0::AdBlockingConfiguration::Representation + + collection :additional_creative_optimization_configurations, as: 'additionalCreativeOptimizationConfigurations', class: Google::Apis::DfareportingV3_0::CreativeOptimizationConfiguration, decorator: Google::Apis::DfareportingV3_0::CreativeOptimizationConfiguration::Representation + + property :advertiser_group_id, :numeric_string => true, as: 'advertiserGroupId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :archived, as: 'archived' + collection :audience_segment_groups, as: 'audienceSegmentGroups', class: Google::Apis::DfareportingV3_0::AudienceSegmentGroup, decorator: Google::Apis::DfareportingV3_0::AudienceSegmentGroup::Representation + + property :billing_invoice_code, as: 'billingInvoiceCode' + property :click_through_url_suffix_properties, as: 'clickThroughUrlSuffixProperties', class: Google::Apis::DfareportingV3_0::ClickThroughUrlSuffixProperties, decorator: Google::Apis::DfareportingV3_0::ClickThroughUrlSuffixProperties::Representation + + property :comment, as: 'comment' + property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation + + collection :creative_group_ids, as: 'creativeGroupIds' + property :creative_optimization_configuration, as: 'creativeOptimizationConfiguration', class: Google::Apis::DfareportingV3_0::CreativeOptimizationConfiguration, decorator: Google::Apis::DfareportingV3_0::CreativeOptimizationConfiguration::Representation + + property :default_click_through_event_tag_properties, as: 'defaultClickThroughEventTagProperties', class: Google::Apis::DfareportingV3_0::DefaultClickThroughEventTagProperties, decorator: Google::Apis::DfareportingV3_0::DefaultClickThroughEventTagProperties::Representation + + property :default_landing_page_id, :numeric_string => true, as: 'defaultLandingPageId' + property :end_date, as: 'endDate', type: Date + + collection :event_tag_overrides, as: 'eventTagOverrides', class: Google::Apis::DfareportingV3_0::EventTagOverride, decorator: Google::Apis::DfareportingV3_0::EventTagOverride::Representation + + property :external_id, as: 'externalId' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation + + property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV3_0::LookbackConfiguration, decorator: Google::Apis::DfareportingV3_0::LookbackConfiguration::Representation + + property :name, as: 'name' + property :nielsen_ocr_enabled, as: 'nielsenOcrEnabled' + property :start_date, as: 'startDate', type: Date + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + collection :trafficker_emails, as: 'traffickerEmails' + end + end + + class CampaignCreativeAssociation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creative_id, :numeric_string => true, as: 'creativeId' + property :kind, as: 'kind' + end + end + + class CampaignCreativeAssociationsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :campaign_creative_associations, as: 'campaignCreativeAssociations', class: Google::Apis::DfareportingV3_0::CampaignCreativeAssociation, decorator: Google::Apis::DfareportingV3_0::CampaignCreativeAssociation::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class CampaignsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :campaigns, as: 'campaigns', class: Google::Apis::DfareportingV3_0::Campaign, decorator: Google::Apis::DfareportingV3_0::Campaign::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class ChangeLog + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :action, as: 'action' + property :change_time, as: 'changeTime', type: DateTime + + property :field_name, as: 'fieldName' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :new_value, as: 'newValue' + property :object_id_prop, :numeric_string => true, as: 'objectId' + property :object_type, as: 'objectType' + property :old_value, as: 'oldValue' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :transaction_id, :numeric_string => true, as: 'transactionId' + property :user_profile_id, :numeric_string => true, as: 'userProfileId' + property :user_profile_name, as: 'userProfileName' + end + end + + class ChangeLogsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :change_logs, as: 'changeLogs', class: Google::Apis::DfareportingV3_0::ChangeLog, decorator: Google::Apis::DfareportingV3_0::ChangeLog::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class CitiesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :cities, as: 'cities', class: Google::Apis::DfareportingV3_0::City, decorator: Google::Apis::DfareportingV3_0::City::Representation + + property :kind, as: 'kind' + end + end + + class City + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :country_code, as: 'countryCode' + property :country_dart_id, :numeric_string => true, as: 'countryDartId' + property :dart_id, :numeric_string => true, as: 'dartId' + property :kind, as: 'kind' + property :metro_code, as: 'metroCode' + property :metro_dma_id, :numeric_string => true, as: 'metroDmaId' + property :name, as: 'name' + property :region_code, as: 'regionCode' + property :region_dart_id, :numeric_string => true, as: 'regionDartId' + end + end + + class ClickTag + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV3_0::CreativeClickThroughUrl, decorator: Google::Apis::DfareportingV3_0::CreativeClickThroughUrl::Representation + + property :event_name, as: 'eventName' + property :name, as: 'name' + end + end + + class ClickThroughUrl + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :computed_click_through_url, as: 'computedClickThroughUrl' + property :custom_click_through_url, as: 'customClickThroughUrl' + property :default_landing_page, as: 'defaultLandingPage' + property :landing_page_id, :numeric_string => true, as: 'landingPageId' + end + end + + class ClickThroughUrlSuffixProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_through_url_suffix, as: 'clickThroughUrlSuffix' + property :override_inherited_suffix, as: 'overrideInheritedSuffix' + end + end + + class CompanionClickThroughOverride + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV3_0::ClickThroughUrl, decorator: Google::Apis::DfareportingV3_0::ClickThroughUrl::Representation + + property :creative_id, :numeric_string => true, as: 'creativeId' + end + end + + class CompanionSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :companions_disabled, as: 'companionsDisabled' + collection :enabled_sizes, as: 'enabledSizes', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation + + property :image_only, as: 'imageOnly' + property :kind, as: 'kind' + end + end + + class CompatibleFields + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cross_dimension_reach_report_compatible_fields, as: 'crossDimensionReachReportCompatibleFields', class: Google::Apis::DfareportingV3_0::CrossDimensionReachReportCompatibleFields, decorator: Google::Apis::DfareportingV3_0::CrossDimensionReachReportCompatibleFields::Representation + + property :floodlight_report_compatible_fields, as: 'floodlightReportCompatibleFields', class: Google::Apis::DfareportingV3_0::FloodlightReportCompatibleFields, decorator: Google::Apis::DfareportingV3_0::FloodlightReportCompatibleFields::Representation + + property :kind, as: 'kind' + property :path_to_conversion_report_compatible_fields, as: 'pathToConversionReportCompatibleFields', class: Google::Apis::DfareportingV3_0::PathToConversionReportCompatibleFields, decorator: Google::Apis::DfareportingV3_0::PathToConversionReportCompatibleFields::Representation + + property :reach_report_compatible_fields, as: 'reachReportCompatibleFields', class: Google::Apis::DfareportingV3_0::ReachReportCompatibleFields, decorator: Google::Apis::DfareportingV3_0::ReachReportCompatibleFields::Representation + + property :report_compatible_fields, as: 'reportCompatibleFields', class: Google::Apis::DfareportingV3_0::ReportCompatibleFields, decorator: Google::Apis::DfareportingV3_0::ReportCompatibleFields::Representation + + end + end + + class ConnectionType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class ConnectionTypesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :connection_types, as: 'connectionTypes', class: Google::Apis::DfareportingV3_0::ConnectionType, decorator: Google::Apis::DfareportingV3_0::ConnectionType::Representation + + property :kind, as: 'kind' + end + end + + class ContentCategoriesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :content_categories, as: 'contentCategories', class: Google::Apis::DfareportingV3_0::ContentCategory, decorator: Google::Apis::DfareportingV3_0::ContentCategory::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class ContentCategory + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class Conversion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :child_directed_treatment, as: 'childDirectedTreatment' + collection :custom_variables, as: 'customVariables', class: Google::Apis::DfareportingV3_0::CustomFloodlightVariable, decorator: Google::Apis::DfareportingV3_0::CustomFloodlightVariable::Representation + + property :encrypted_user_id, as: 'encryptedUserId' + collection :encrypted_user_id_candidates, as: 'encryptedUserIdCandidates' + property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' + property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' + property :gclid, as: 'gclid' + property :kind, as: 'kind' + property :limit_ad_tracking, as: 'limitAdTracking' + property :mobile_device_id, as: 'mobileDeviceId' + property :ordinal, as: 'ordinal' + property :quantity, :numeric_string => true, as: 'quantity' + property :timestamp_micros, :numeric_string => true, as: 'timestampMicros' + property :value, as: 'value' + end + end + + class ConversionError + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + property :kind, as: 'kind' + property :message, as: 'message' + end + end + + class ConversionStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :conversion, as: 'conversion', class: Google::Apis::DfareportingV3_0::Conversion, decorator: Google::Apis::DfareportingV3_0::Conversion::Representation + + collection :errors, as: 'errors', class: Google::Apis::DfareportingV3_0::ConversionError, decorator: Google::Apis::DfareportingV3_0::ConversionError::Representation + + property :kind, as: 'kind' + end + end + + class ConversionsBatchInsertRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :conversions, as: 'conversions', class: Google::Apis::DfareportingV3_0::Conversion, decorator: Google::Apis::DfareportingV3_0::Conversion::Representation + + property :encryption_info, as: 'encryptionInfo', class: Google::Apis::DfareportingV3_0::EncryptionInfo, decorator: Google::Apis::DfareportingV3_0::EncryptionInfo::Representation + + property :kind, as: 'kind' + end + end + + class ConversionsBatchInsertResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :has_failures, as: 'hasFailures' + property :kind, as: 'kind' + collection :status, as: 'status', class: Google::Apis::DfareportingV3_0::ConversionStatus, decorator: Google::Apis::DfareportingV3_0::ConversionStatus::Representation + + end + end + + class ConversionsBatchUpdateRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :conversions, as: 'conversions', class: Google::Apis::DfareportingV3_0::Conversion, decorator: Google::Apis::DfareportingV3_0::Conversion::Representation + + property :encryption_info, as: 'encryptionInfo', class: Google::Apis::DfareportingV3_0::EncryptionInfo, decorator: Google::Apis::DfareportingV3_0::EncryptionInfo::Representation + + property :kind, as: 'kind' + end + end + + class ConversionsBatchUpdateResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :has_failures, as: 'hasFailures' + property :kind, as: 'kind' + collection :status, as: 'status', class: Google::Apis::DfareportingV3_0::ConversionStatus, decorator: Google::Apis::DfareportingV3_0::ConversionStatus::Representation + + end + end + + class CountriesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :countries, as: 'countries', class: Google::Apis::DfareportingV3_0::Country, decorator: Google::Apis::DfareportingV3_0::Country::Representation + + property :kind, as: 'kind' + end + end + + class Country + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :country_code, as: 'countryCode' + property :dart_id, :numeric_string => true, as: 'dartId' + property :kind, as: 'kind' + property :name, as: 'name' + property :ssl_enabled, as: 'sslEnabled' + end + end + + class Creative + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :active, as: 'active' + property :ad_parameters, as: 'adParameters' + collection :ad_tag_keys, as: 'adTagKeys' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :allow_script_access, as: 'allowScriptAccess' + property :archived, as: 'archived' + property :artwork_type, as: 'artworkType' + property :authoring_source, as: 'authoringSource' + property :authoring_tool, as: 'authoringTool' + property :auto_advance_images, as: 'autoAdvanceImages' + property :background_color, as: 'backgroundColor' + property :backup_image_click_through_url, as: 'backupImageClickThroughUrl', class: Google::Apis::DfareportingV3_0::CreativeClickThroughUrl, decorator: Google::Apis::DfareportingV3_0::CreativeClickThroughUrl::Representation + + collection :backup_image_features, as: 'backupImageFeatures' + property :backup_image_reporting_label, as: 'backupImageReportingLabel' + property :backup_image_target_window, as: 'backupImageTargetWindow', class: Google::Apis::DfareportingV3_0::TargetWindow, decorator: Google::Apis::DfareportingV3_0::TargetWindow::Representation + + collection :click_tags, as: 'clickTags', class: Google::Apis::DfareportingV3_0::ClickTag, decorator: Google::Apis::DfareportingV3_0::ClickTag::Representation + + property :commercial_id, as: 'commercialId' + collection :companion_creatives, as: 'companionCreatives' + collection :compatibility, as: 'compatibility' + property :convert_flash_to_html5, as: 'convertFlashToHtml5' + collection :counter_custom_events, as: 'counterCustomEvents', class: Google::Apis::DfareportingV3_0::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_0::CreativeCustomEvent::Representation + + property :creative_asset_selection, as: 'creativeAssetSelection', class: Google::Apis::DfareportingV3_0::CreativeAssetSelection, decorator: Google::Apis::DfareportingV3_0::CreativeAssetSelection::Representation + + collection :creative_assets, as: 'creativeAssets', class: Google::Apis::DfareportingV3_0::CreativeAsset, decorator: Google::Apis::DfareportingV3_0::CreativeAsset::Representation + + collection :creative_field_assignments, as: 'creativeFieldAssignments', class: Google::Apis::DfareportingV3_0::CreativeFieldAssignment, decorator: Google::Apis::DfareportingV3_0::CreativeFieldAssignment::Representation + + collection :custom_key_values, as: 'customKeyValues' + property :dynamic_asset_selection, as: 'dynamicAssetSelection' + collection :exit_custom_events, as: 'exitCustomEvents', class: Google::Apis::DfareportingV3_0::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_0::CreativeCustomEvent::Representation + + property :fs_command, as: 'fsCommand', class: Google::Apis::DfareportingV3_0::FsCommand, decorator: Google::Apis::DfareportingV3_0::FsCommand::Representation + + property :html_code, as: 'htmlCode' + property :html_code_locked, as: 'htmlCodeLocked' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation + + property :latest_trafficked_creative_id, :numeric_string => true, as: 'latestTraffickedCreativeId' + property :name, as: 'name' + property :override_css, as: 'overrideCss' + property :polite_load_asset_id, :numeric_string => true, as: 'politeLoadAssetId' + property :progress_offset, as: 'progressOffset', class: Google::Apis::DfareportingV3_0::VideoOffset, decorator: Google::Apis::DfareportingV3_0::VideoOffset::Representation + + property :redirect_url, as: 'redirectUrl' + property :rendering_id, :numeric_string => true, as: 'renderingId' + property :rendering_id_dimension_value, as: 'renderingIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :required_flash_plugin_version, as: 'requiredFlashPluginVersion' + property :required_flash_version, as: 'requiredFlashVersion' + property :size, as: 'size', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation + + property :skip_offset, as: 'skipOffset', class: Google::Apis::DfareportingV3_0::VideoOffset, decorator: Google::Apis::DfareportingV3_0::VideoOffset::Representation + + property :skippable, as: 'skippable' + property :ssl_compliant, as: 'sslCompliant' + property :ssl_override, as: 'sslOverride' + property :studio_advertiser_id, :numeric_string => true, as: 'studioAdvertiserId' + property :studio_creative_id, :numeric_string => true, as: 'studioCreativeId' + property :studio_trafficked_creative_id, :numeric_string => true, as: 'studioTraffickedCreativeId' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :third_party_backup_image_impressions_url, as: 'thirdPartyBackupImageImpressionsUrl' + property :third_party_rich_media_impressions_url, as: 'thirdPartyRichMediaImpressionsUrl' + collection :third_party_urls, as: 'thirdPartyUrls', class: Google::Apis::DfareportingV3_0::ThirdPartyTrackingUrl, decorator: Google::Apis::DfareportingV3_0::ThirdPartyTrackingUrl::Representation + + collection :timer_custom_events, as: 'timerCustomEvents', class: Google::Apis::DfareportingV3_0::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_0::CreativeCustomEvent::Representation + + property :total_file_size, :numeric_string => true, as: 'totalFileSize' + property :type, as: 'type' + property :universal_ad_id, as: 'universalAdId', class: Google::Apis::DfareportingV3_0::UniversalAdId, decorator: Google::Apis::DfareportingV3_0::UniversalAdId::Representation + + property :version, as: 'version' + property :video_description, as: 'videoDescription' + property :video_duration, as: 'videoDuration' + end + end + + class CreativeAsset + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action_script3, as: 'actionScript3' + property :active, as: 'active' + property :alignment, as: 'alignment' + property :artwork_type, as: 'artworkType' + property :asset_identifier, as: 'assetIdentifier', class: Google::Apis::DfareportingV3_0::CreativeAssetId, decorator: Google::Apis::DfareportingV3_0::CreativeAssetId::Representation + + property :backup_image_exit, as: 'backupImageExit', class: Google::Apis::DfareportingV3_0::CreativeCustomEvent, decorator: Google::Apis::DfareportingV3_0::CreativeCustomEvent::Representation + + property :bit_rate, as: 'bitRate' + property :child_asset_type, as: 'childAssetType' + property :collapsed_size, as: 'collapsedSize', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation + + collection :companion_creative_ids, as: 'companionCreativeIds' + property :custom_start_time_value, as: 'customStartTimeValue' + collection :detected_features, as: 'detectedFeatures' + property :display_type, as: 'displayType' + property :duration, as: 'duration' + property :duration_type, as: 'durationType' + property :expanded_dimension, as: 'expandedDimension', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation + + property :file_size, :numeric_string => true, as: 'fileSize' + property :flash_version, as: 'flashVersion' + property :hide_flash_objects, as: 'hideFlashObjects' + property :hide_selection_boxes, as: 'hideSelectionBoxes' + property :horizontally_locked, as: 'horizontallyLocked' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :mime_type, as: 'mimeType' + property :offset, as: 'offset', class: Google::Apis::DfareportingV3_0::OffsetPosition, decorator: Google::Apis::DfareportingV3_0::OffsetPosition::Representation + + property :orientation, as: 'orientation' + property :original_backup, as: 'originalBackup' + property :position, as: 'position', class: Google::Apis::DfareportingV3_0::OffsetPosition, decorator: Google::Apis::DfareportingV3_0::OffsetPosition::Representation + + property :position_left_unit, as: 'positionLeftUnit' + property :position_top_unit, as: 'positionTopUnit' + property :progressive_serving_url, as: 'progressiveServingUrl' + property :pushdown, as: 'pushdown' + property :pushdown_duration, as: 'pushdownDuration' + property :role, as: 'role' + property :size, as: 'size', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation + + property :ssl_compliant, as: 'sslCompliant' + property :start_time_type, as: 'startTimeType' + property :streaming_serving_url, as: 'streamingServingUrl' + property :transparency, as: 'transparency' + property :vertically_locked, as: 'verticallyLocked' + property :video_duration, as: 'videoDuration' + property :window_mode, as: 'windowMode' + property :z_index, as: 'zIndex' + property :zip_filename, as: 'zipFilename' + property :zip_filesize, as: 'zipFilesize' + end + end + + class CreativeAssetId + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :type, as: 'type' + end + end + + class CreativeAssetMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :asset_identifier, as: 'assetIdentifier', class: Google::Apis::DfareportingV3_0::CreativeAssetId, decorator: Google::Apis::DfareportingV3_0::CreativeAssetId::Representation + + collection :click_tags, as: 'clickTags', class: Google::Apis::DfareportingV3_0::ClickTag, decorator: Google::Apis::DfareportingV3_0::ClickTag::Representation + + collection :detected_features, as: 'detectedFeatures' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :kind, as: 'kind' + collection :warned_validation_rules, as: 'warnedValidationRules' + end + end + + class CreativeAssetSelection + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :default_asset_id, :numeric_string => true, as: 'defaultAssetId' + collection :rules, as: 'rules', class: Google::Apis::DfareportingV3_0::Rule, decorator: Google::Apis::DfareportingV3_0::Rule::Representation + + end + end + + class CreativeAssignment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :active, as: 'active' + property :apply_event_tags, as: 'applyEventTags' + property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV3_0::ClickThroughUrl, decorator: Google::Apis::DfareportingV3_0::ClickThroughUrl::Representation + + collection :companion_creative_overrides, as: 'companionCreativeOverrides', class: Google::Apis::DfareportingV3_0::CompanionClickThroughOverride, decorator: Google::Apis::DfareportingV3_0::CompanionClickThroughOverride::Representation + + collection :creative_group_assignments, as: 'creativeGroupAssignments', class: Google::Apis::DfareportingV3_0::CreativeGroupAssignment, decorator: Google::Apis::DfareportingV3_0::CreativeGroupAssignment::Representation + + property :creative_id, :numeric_string => true, as: 'creativeId' + property :creative_id_dimension_value, as: 'creativeIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :end_time, as: 'endTime', type: DateTime + + collection :rich_media_exit_overrides, as: 'richMediaExitOverrides', class: Google::Apis::DfareportingV3_0::RichMediaExitOverride, decorator: Google::Apis::DfareportingV3_0::RichMediaExitOverride::Representation + + property :sequence, as: 'sequence' + property :ssl_compliant, as: 'sslCompliant' + property :start_time, as: 'startTime', type: DateTime + + property :weight, as: 'weight' + end + end + + class CreativeClickThroughUrl + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :computed_click_through_url, as: 'computedClickThroughUrl' + property :custom_click_through_url, as: 'customClickThroughUrl' + property :landing_page_id, :numeric_string => true, as: 'landingPageId' + end + end + + class CreativeCustomEvent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :advertiser_custom_event_id, :numeric_string => true, as: 'advertiserCustomEventId' + property :advertiser_custom_event_name, as: 'advertiserCustomEventName' + property :advertiser_custom_event_type, as: 'advertiserCustomEventType' + property :artwork_label, as: 'artworkLabel' + property :artwork_type, as: 'artworkType' + property :exit_click_through_url, as: 'exitClickThroughUrl', class: Google::Apis::DfareportingV3_0::CreativeClickThroughUrl, decorator: Google::Apis::DfareportingV3_0::CreativeClickThroughUrl::Representation + + property :id, :numeric_string => true, as: 'id' + property :popup_window_properties, as: 'popupWindowProperties', class: Google::Apis::DfareportingV3_0::PopupWindowProperties, decorator: Google::Apis::DfareportingV3_0::PopupWindowProperties::Representation + + property :target_type, as: 'targetType' + property :video_reporting_id, as: 'videoReportingId' + end + end + + class CreativeField + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + end + end + + class CreativeFieldAssignment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creative_field_id, :numeric_string => true, as: 'creativeFieldId' + property :creative_field_value_id, :numeric_string => true, as: 'creativeFieldValueId' + end + end + + class CreativeFieldValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :value, as: 'value' + end + end + + class CreativeFieldValuesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :creative_field_values, as: 'creativeFieldValues', class: Google::Apis::DfareportingV3_0::CreativeFieldValue, decorator: Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class CreativeFieldsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :creative_fields, as: 'creativeFields', class: Google::Apis::DfareportingV3_0::CreativeField, decorator: Google::Apis::DfareportingV3_0::CreativeField::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class CreativeGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :group_number, as: 'groupNumber' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + end + end + + class CreativeGroupAssignment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creative_group_id, :numeric_string => true, as: 'creativeGroupId' + property :creative_group_number, as: 'creativeGroupNumber' + end + end + + class CreativeGroupsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :creative_groups, as: 'creativeGroups', class: Google::Apis::DfareportingV3_0::CreativeGroup, decorator: Google::Apis::DfareportingV3_0::CreativeGroup::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class CreativeOptimizationConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, as: 'id' + property :name, as: 'name' + collection :optimization_activitys, as: 'optimizationActivitys', class: Google::Apis::DfareportingV3_0::OptimizationActivity, decorator: Google::Apis::DfareportingV3_0::OptimizationActivity::Representation + + property :optimization_model, as: 'optimizationModel' + end + end + + class CreativeRotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :creative_assignments, as: 'creativeAssignments', class: Google::Apis::DfareportingV3_0::CreativeAssignment, decorator: Google::Apis::DfareportingV3_0::CreativeAssignment::Representation + + property :creative_optimization_configuration_id, :numeric_string => true, as: 'creativeOptimizationConfigurationId' + property :type, as: 'type' + property :weight_calculation_strategy, as: 'weightCalculationStrategy' + end + end + + class CreativeSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :i_frame_footer, as: 'iFrameFooter' + property :i_frame_header, as: 'iFrameHeader' + end + end + + class CreativesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :creatives, as: 'creatives', class: Google::Apis::DfareportingV3_0::Creative, decorator: Google::Apis::DfareportingV3_0::Creative::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class CrossDimensionReachReportCompatibleFields + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :breakdown, as: 'breakdown', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation + + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation + + collection :overlap_metrics, as: 'overlapMetrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation + + end + end + + class CustomFloodlightVariable + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :type, as: 'type' + property :value, as: 'value' + end + end + + class CustomRichMediaEvents + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :filtered_event_ids, as: 'filteredEventIds', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :kind, as: 'kind' + end + end + + class DateRange + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_date, as: 'endDate', type: Date + + property :kind, as: 'kind' + property :relative_date_range, as: 'relativeDateRange' + property :start_date, as: 'startDate', type: Date + + end + end + + class DayPartTargeting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :days_of_week, as: 'daysOfWeek' + collection :hours_of_day, as: 'hoursOfDay' + property :user_local_time, as: 'userLocalTime' + end + end + + class DefaultClickThroughEventTagProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :default_click_through_event_tag_id, :numeric_string => true, as: 'defaultClickThroughEventTagId' + property :override_inherited_event_tag, as: 'overrideInheritedEventTag' + end + end + + class DeliverySchedule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :frequency_cap, as: 'frequencyCap', class: Google::Apis::DfareportingV3_0::FrequencyCap, decorator: Google::Apis::DfareportingV3_0::FrequencyCap::Representation + + property :hard_cutoff, as: 'hardCutoff' + property :impression_ratio, :numeric_string => true, as: 'impressionRatio' + property :priority, as: 'priority' + end + end + + class DfpSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dfp_network_code, as: 'dfpNetworkCode' + property :dfp_network_name, as: 'dfpNetworkName' + property :programmatic_placement_accepted, as: 'programmaticPlacementAccepted' + property :pub_paid_placement_accepted, as: 'pubPaidPlacementAccepted' + property :publisher_portal_only, as: 'publisherPortalOnly' + end + end + + class Dimension + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class DimensionFilter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimension_name, as: 'dimensionName' + property :kind, as: 'kind' + property :value, as: 'value' + end + end + + class DimensionValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimension_name, as: 'dimensionName' + property :etag, as: 'etag' + property :id, as: 'id' + property :kind, as: 'kind' + property :match_type, as: 'matchType' + property :value, as: 'value' + end + end + + class DimensionValueList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + collection :items, as: 'items', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class DimensionValueRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimension_name, as: 'dimensionName' + property :end_date, as: 'endDate', type: Date + + collection :filters, as: 'filters', class: Google::Apis::DfareportingV3_0::DimensionFilter, decorator: Google::Apis::DfareportingV3_0::DimensionFilter::Representation + + property :kind, as: 'kind' + property :start_date, as: 'startDate', type: Date + + end + end + + class DirectorySite + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :active, as: 'active' + collection :contact_assignments, as: 'contactAssignments', class: Google::Apis::DfareportingV3_0::DirectorySiteContactAssignment, decorator: Google::Apis::DfareportingV3_0::DirectorySiteContactAssignment::Representation + + property :country_id, :numeric_string => true, as: 'countryId' + property :currency_id, :numeric_string => true, as: 'currencyId' + property :description, as: 'description' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + collection :inpage_tag_formats, as: 'inpageTagFormats' + collection :interstitial_tag_formats, as: 'interstitialTagFormats' + property :kind, as: 'kind' + property :name, as: 'name' + property :parent_id, :numeric_string => true, as: 'parentId' + property :settings, as: 'settings', class: Google::Apis::DfareportingV3_0::DirectorySiteSettings, decorator: Google::Apis::DfareportingV3_0::DirectorySiteSettings::Representation + + property :url, as: 'url' + end + end + + class DirectorySiteContact + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :address, as: 'address' + property :email, as: 'email' + property :first_name, as: 'firstName' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :last_name, as: 'lastName' + property :phone, as: 'phone' + property :role, as: 'role' + property :title, as: 'title' + property :type, as: 'type' + end + end + + class DirectorySiteContactAssignment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :contact_id, :numeric_string => true, as: 'contactId' + property :visibility, as: 'visibility' + end + end + + class DirectorySiteContactsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :directory_site_contacts, as: 'directorySiteContacts', class: Google::Apis::DfareportingV3_0::DirectorySiteContact, decorator: Google::Apis::DfareportingV3_0::DirectorySiteContact::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class DirectorySiteSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :active_view_opt_out, as: 'activeViewOptOut' + property :dfp_settings, as: 'dfpSettings', class: Google::Apis::DfareportingV3_0::DfpSettings, decorator: Google::Apis::DfareportingV3_0::DfpSettings::Representation + + property :instream_video_placement_accepted, as: 'instreamVideoPlacementAccepted' + property :interstitial_placement_accepted, as: 'interstitialPlacementAccepted' + property :nielsen_ocr_opt_out, as: 'nielsenOcrOptOut' + property :verification_tag_opt_out, as: 'verificationTagOptOut' + property :video_active_view_opt_out, as: 'videoActiveViewOptOut' + end + end + + class DirectorySitesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :directory_sites, as: 'directorySites', class: Google::Apis::DfareportingV3_0::DirectorySite, decorator: Google::Apis::DfareportingV3_0::DirectorySite::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class DynamicTargetingKey + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :name, as: 'name' + property :object_id_prop, :numeric_string => true, as: 'objectId' + property :object_type, as: 'objectType' + end + end + + class DynamicTargetingKeysListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dynamic_targeting_keys, as: 'dynamicTargetingKeys', class: Google::Apis::DfareportingV3_0::DynamicTargetingKey, decorator: Google::Apis::DfareportingV3_0::DynamicTargetingKey::Representation + + property :kind, as: 'kind' + end + end + + class EncryptionInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :encryption_entity_id, :numeric_string => true, as: 'encryptionEntityId' + property :encryption_entity_type, as: 'encryptionEntityType' + property :encryption_source, as: 'encryptionSource' + property :kind, as: 'kind' + end + end + + class EventTag + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :campaign_id, :numeric_string => true, as: 'campaignId' + property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :enabled_by_default, as: 'enabledByDefault' + property :exclude_from_adx_requests, as: 'excludeFromAdxRequests' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :site_filter_type, as: 'siteFilterType' + collection :site_ids, as: 'siteIds' + property :ssl_compliant, as: 'sslCompliant' + property :status, as: 'status' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :type, as: 'type' + property :url, as: 'url' + property :url_escape_levels, as: 'urlEscapeLevels' + end + end + + class EventTagOverride + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :enabled, as: 'enabled' + property :id, :numeric_string => true, as: 'id' + end + end + + class EventTagsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :event_tags, as: 'eventTags', class: Google::Apis::DfareportingV3_0::EventTag, decorator: Google::Apis::DfareportingV3_0::EventTag::Representation + + property :kind, as: 'kind' + end + end + + class File + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_0::DateRange, decorator: Google::Apis::DfareportingV3_0::DateRange::Representation + + property :etag, as: 'etag' + property :file_name, as: 'fileName' + property :format, as: 'format' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :last_modified_time, :numeric_string => true, as: 'lastModifiedTime' + property :report_id, :numeric_string => true, as: 'reportId' + property :status, as: 'status' + property :urls, as: 'urls', class: Google::Apis::DfareportingV3_0::File::Urls, decorator: Google::Apis::DfareportingV3_0::File::Urls::Representation + + end + + class Urls + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_url, as: 'apiUrl' + property :browser_url, as: 'browserUrl' + end + end + end + + class FileList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + collection :items, as: 'items', class: Google::Apis::DfareportingV3_0::File, decorator: Google::Apis::DfareportingV3_0::File::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class Flight + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_date, as: 'endDate', type: Date + + property :rate_or_cost, :numeric_string => true, as: 'rateOrCost' + property :start_date, as: 'startDate', type: Date + + property :units, :numeric_string => true, as: 'units' + end + end + + class FloodlightActivitiesGenerateTagResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :floodlight_activity_tag, as: 'floodlightActivityTag' + property :global_site_tag_global_snippet, as: 'globalSiteTagGlobalSnippet' + property :kind, as: 'kind' + end + end + + class FloodlightActivitiesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :floodlight_activities, as: 'floodlightActivities', class: Google::Apis::DfareportingV3_0::FloodlightActivity, decorator: Google::Apis::DfareportingV3_0::FloodlightActivity::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class FloodlightActivity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :cache_busting_type, as: 'cacheBustingType' + property :counting_method, as: 'countingMethod' + collection :default_tags, as: 'defaultTags', class: Google::Apis::DfareportingV3_0::FloodlightActivityDynamicTag, decorator: Google::Apis::DfareportingV3_0::FloodlightActivityDynamicTag::Representation + + property :expected_url, as: 'expectedUrl' + property :floodlight_activity_group_id, :numeric_string => true, as: 'floodlightActivityGroupId' + property :floodlight_activity_group_name, as: 'floodlightActivityGroupName' + property :floodlight_activity_group_tag_string, as: 'floodlightActivityGroupTagString' + property :floodlight_activity_group_type, as: 'floodlightActivityGroupType' + property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' + property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :floodlight_tag_type, as: 'floodlightTagType' + property :hidden, as: 'hidden' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :kind, as: 'kind' + property :name, as: 'name' + property :notes, as: 'notes' + collection :publisher_tags, as: 'publisherTags', class: Google::Apis::DfareportingV3_0::FloodlightActivityPublisherDynamicTag, decorator: Google::Apis::DfareportingV3_0::FloodlightActivityPublisherDynamicTag::Representation + + property :secure, as: 'secure' + property :ssl_compliant, as: 'sslCompliant' + property :ssl_required, as: 'sslRequired' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :tag_format, as: 'tagFormat' + property :tag_string, as: 'tagString' + collection :user_defined_variable_types, as: 'userDefinedVariableTypes' + end + end + + class FloodlightActivityDynamicTag + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, as: 'id' + property :name, as: 'name' + property :tag, as: 'tag' + end + end + + class FloodlightActivityGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' + property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :kind, as: 'kind' + property :name, as: 'name' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :tag_string, as: 'tagString' + property :type, as: 'type' + end + end + + class FloodlightActivityGroupsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :floodlight_activity_groups, as: 'floodlightActivityGroups', class: Google::Apis::DfareportingV3_0::FloodlightActivityGroup, decorator: Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class FloodlightActivityPublisherDynamicTag + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_through, as: 'clickThrough' + property :directory_site_id, :numeric_string => true, as: 'directorySiteId' + property :dynamic_tag, as: 'dynamicTag', class: Google::Apis::DfareportingV3_0::FloodlightActivityDynamicTag, decorator: Google::Apis::DfareportingV3_0::FloodlightActivityDynamicTag::Representation + + property :site_id, :numeric_string => true, as: 'siteId' + property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :view_through, as: 'viewThrough' + end + end + + class FloodlightConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :analytics_data_sharing_enabled, as: 'analyticsDataSharingEnabled' + property :exposure_to_conversion_enabled, as: 'exposureToConversionEnabled' + property :first_day_of_week, as: 'firstDayOfWeek' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :in_app_attribution_tracking_enabled, as: 'inAppAttributionTrackingEnabled' + property :kind, as: 'kind' + property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV3_0::LookbackConfiguration, decorator: Google::Apis::DfareportingV3_0::LookbackConfiguration::Representation + + property :natural_search_conversion_attribution_option, as: 'naturalSearchConversionAttributionOption' + property :omniture_settings, as: 'omnitureSettings', class: Google::Apis::DfareportingV3_0::OmnitureSettings, decorator: Google::Apis::DfareportingV3_0::OmnitureSettings::Representation + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :tag_settings, as: 'tagSettings', class: Google::Apis::DfareportingV3_0::TagSettings, decorator: Google::Apis::DfareportingV3_0::TagSettings::Representation + + collection :third_party_authentication_tokens, as: 'thirdPartyAuthenticationTokens', class: Google::Apis::DfareportingV3_0::ThirdPartyAuthenticationToken, decorator: Google::Apis::DfareportingV3_0::ThirdPartyAuthenticationToken::Representation + + collection :user_defined_variable_configurations, as: 'userDefinedVariableConfigurations', class: Google::Apis::DfareportingV3_0::UserDefinedVariableConfiguration, decorator: Google::Apis::DfareportingV3_0::UserDefinedVariableConfiguration::Representation + + end + end + + class FloodlightConfigurationsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :floodlight_configurations, as: 'floodlightConfigurations', class: Google::Apis::DfareportingV3_0::FloodlightConfiguration, decorator: Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation + + property :kind, as: 'kind' + end + end + + class FloodlightReportCompatibleFields + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation + + end + end + + class FrequencyCap + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :duration, :numeric_string => true, as: 'duration' + property :impressions, :numeric_string => true, as: 'impressions' + end + end + + class FsCommand + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :left, as: 'left' + property :position_option, as: 'positionOption' + property :top, as: 'top' + property :window_height, as: 'windowHeight' + property :window_width, as: 'windowWidth' + end + end + + class GeoTargeting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :cities, as: 'cities', class: Google::Apis::DfareportingV3_0::City, decorator: Google::Apis::DfareportingV3_0::City::Representation + + collection :countries, as: 'countries', class: Google::Apis::DfareportingV3_0::Country, decorator: Google::Apis::DfareportingV3_0::Country::Representation + + property :exclude_countries, as: 'excludeCountries' + collection :metros, as: 'metros', class: Google::Apis::DfareportingV3_0::Metro, decorator: Google::Apis::DfareportingV3_0::Metro::Representation + + collection :postal_codes, as: 'postalCodes', class: Google::Apis::DfareportingV3_0::PostalCode, decorator: Google::Apis::DfareportingV3_0::PostalCode::Representation + + collection :regions, as: 'regions', class: Google::Apis::DfareportingV3_0::Region, decorator: Google::Apis::DfareportingV3_0::Region::Representation + + end + end + + class InventoryItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + collection :ad_slots, as: 'adSlots', class: Google::Apis::DfareportingV3_0::AdSlot, decorator: Google::Apis::DfareportingV3_0::AdSlot::Representation + + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :content_category_id, :numeric_string => true, as: 'contentCategoryId' + property :estimated_click_through_rate, :numeric_string => true, as: 'estimatedClickThroughRate' + property :estimated_conversion_rate, :numeric_string => true, as: 'estimatedConversionRate' + property :id, :numeric_string => true, as: 'id' + property :in_plan, as: 'inPlan' + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation + + property :name, as: 'name' + property :negotiation_channel_id, :numeric_string => true, as: 'negotiationChannelId' + property :order_id, :numeric_string => true, as: 'orderId' + property :placement_strategy_id, :numeric_string => true, as: 'placementStrategyId' + property :pricing, as: 'pricing', class: Google::Apis::DfareportingV3_0::Pricing, decorator: Google::Apis::DfareportingV3_0::Pricing::Representation + + property :project_id, :numeric_string => true, as: 'projectId' + property :rfp_id, :numeric_string => true, as: 'rfpId' + property :site_id, :numeric_string => true, as: 'siteId' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :type, as: 'type' + end + end + + class InventoryItemsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :inventory_items, as: 'inventoryItems', class: Google::Apis::DfareportingV3_0::InventoryItem, decorator: Google::Apis::DfareportingV3_0::InventoryItem::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class KeyValueTargetingExpression + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :expression, as: 'expression' + end + end + + class LandingPage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :archived, as: 'archived' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :url, as: 'url' + end + end + + class Language + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :language_code, as: 'languageCode' + property :name, as: 'name' + end + end + + class LanguageTargeting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :languages, as: 'languages', class: Google::Apis::DfareportingV3_0::Language, decorator: Google::Apis::DfareportingV3_0::Language::Representation + + end + end + + class LanguagesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :languages, as: 'languages', class: Google::Apis::DfareportingV3_0::Language, decorator: Google::Apis::DfareportingV3_0::Language::Representation + + end + end + + class LastModifiedInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :time, :numeric_string => true, as: 'time' + end + end + + class ListPopulationClause + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :terms, as: 'terms', class: Google::Apis::DfareportingV3_0::ListPopulationTerm, decorator: Google::Apis::DfareportingV3_0::ListPopulationTerm::Representation + + end + end + + class ListPopulationRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' + property :floodlight_activity_name, as: 'floodlightActivityName' + collection :list_population_clauses, as: 'listPopulationClauses', class: Google::Apis::DfareportingV3_0::ListPopulationClause, decorator: Google::Apis::DfareportingV3_0::ListPopulationClause::Representation + + end + end + + class ListPopulationTerm + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :contains, as: 'contains' + property :negation, as: 'negation' + property :operator, as: 'operator' + property :remarketing_list_id, :numeric_string => true, as: 'remarketingListId' + property :type, as: 'type' + property :value, as: 'value' + property :variable_friendly_name, as: 'variableFriendlyName' + property :variable_name, as: 'variableName' + end + end + + class ListTargetingExpression + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :expression, as: 'expression' + end + end + + class LookbackConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_duration, as: 'clickDuration' + property :post_impression_activities_duration, as: 'postImpressionActivitiesDuration' + end + end + + class Metric + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class Metro + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :country_code, as: 'countryCode' + property :country_dart_id, :numeric_string => true, as: 'countryDartId' + property :dart_id, :numeric_string => true, as: 'dartId' + property :dma_id, :numeric_string => true, as: 'dmaId' + property :kind, as: 'kind' + property :metro_code, as: 'metroCode' + property :name, as: 'name' + end + end + + class MetrosListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :metros, as: 'metros', class: Google::Apis::DfareportingV3_0::Metro, decorator: Google::Apis::DfareportingV3_0::Metro::Representation + + end + end + + class MobileCarrier + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :country_code, as: 'countryCode' + property :country_dart_id, :numeric_string => true, as: 'countryDartId' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class MobileCarriersListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :mobile_carriers, as: 'mobileCarriers', class: Google::Apis::DfareportingV3_0::MobileCarrier, decorator: Google::Apis::DfareportingV3_0::MobileCarrier::Representation + + end + end + + class ObjectFilter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :object_ids, as: 'objectIds' + property :status, as: 'status' + end + end + + class OffsetPosition + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :left, as: 'left' + property :top, as: 'top' + end + end + + class OmnitureSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :omniture_cost_data_enabled, as: 'omnitureCostDataEnabled' + property :omniture_integration_enabled, as: 'omnitureIntegrationEnabled' + end + end + + class OperatingSystem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dart_id, :numeric_string => true, as: 'dartId' + property :desktop, as: 'desktop' + property :kind, as: 'kind' + property :mobile, as: 'mobile' + property :name, as: 'name' + end + end + + class OperatingSystemVersion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :major_version, as: 'majorVersion' + property :minor_version, as: 'minorVersion' + property :name, as: 'name' + property :operating_system, as: 'operatingSystem', class: Google::Apis::DfareportingV3_0::OperatingSystem, decorator: Google::Apis::DfareportingV3_0::OperatingSystem::Representation + + end + end + + class OperatingSystemVersionsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :operating_system_versions, as: 'operatingSystemVersions', class: Google::Apis::DfareportingV3_0::OperatingSystemVersion, decorator: Google::Apis::DfareportingV3_0::OperatingSystemVersion::Representation + + end + end + + class OperatingSystemsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :operating_systems, as: 'operatingSystems', class: Google::Apis::DfareportingV3_0::OperatingSystem, decorator: Google::Apis::DfareportingV3_0::OperatingSystem::Representation + + end + end + + class OptimizationActivity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' + property :floodlight_activity_id_dimension_value, as: 'floodlightActivityIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :weight, as: 'weight' + end + end + + class Order + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + collection :approver_user_profile_ids, as: 'approverUserProfileIds' + property :buyer_invoice_id, as: 'buyerInvoiceId' + property :buyer_organization_name, as: 'buyerOrganizationName' + property :comments, as: 'comments' + collection :contacts, as: 'contacts', class: Google::Apis::DfareportingV3_0::OrderContact, decorator: Google::Apis::DfareportingV3_0::OrderContact::Representation + + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation + + property :name, as: 'name' + property :notes, as: 'notes' + property :planning_term_id, :numeric_string => true, as: 'planningTermId' + property :project_id, :numeric_string => true, as: 'projectId' + property :seller_order_id, as: 'sellerOrderId' + property :seller_organization_name, as: 'sellerOrganizationName' + collection :site_id, as: 'siteId' + collection :site_names, as: 'siteNames' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :terms_and_conditions, as: 'termsAndConditions' + end + end + + class OrderContact + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :contact_info, as: 'contactInfo' + property :contact_name, as: 'contactName' + property :contact_title, as: 'contactTitle' + property :contact_type, as: 'contactType' + property :signature_user_profile_id, :numeric_string => true, as: 'signatureUserProfileId' + end + end + + class OrderDocument + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :amended_order_document_id, :numeric_string => true, as: 'amendedOrderDocumentId' + collection :approved_by_user_profile_ids, as: 'approvedByUserProfileIds' + property :cancelled, as: 'cancelled' + property :created_info, as: 'createdInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation + + property :effective_date, as: 'effectiveDate', type: Date + + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + collection :last_sent_recipients, as: 'lastSentRecipients' + property :last_sent_time, as: 'lastSentTime', type: DateTime + + property :order_id, :numeric_string => true, as: 'orderId' + property :project_id, :numeric_string => true, as: 'projectId' + property :signed, as: 'signed' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :title, as: 'title' + property :type, as: 'type' + end + end + + class OrderDocumentsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :order_documents, as: 'orderDocuments', class: Google::Apis::DfareportingV3_0::OrderDocument, decorator: Google::Apis::DfareportingV3_0::OrderDocument::Representation + + end + end + + class OrdersListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :orders, as: 'orders', class: Google::Apis::DfareportingV3_0::Order, decorator: Google::Apis::DfareportingV3_0::Order::Representation + + end + end + + class PathToConversionReportCompatibleFields + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :conversion_dimensions, as: 'conversionDimensions', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation + + collection :custom_floodlight_variables, as: 'customFloodlightVariables', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation + + collection :per_interaction_dimensions, as: 'perInteractionDimensions', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation + + end + end + + class Placement + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :ad_blocking_opt_out, as: 'adBlockingOptOut' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :archived, as: 'archived' + property :campaign_id, :numeric_string => true, as: 'campaignId' + property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :comment, as: 'comment' + property :compatibility, as: 'compatibility' + property :content_category_id, :numeric_string => true, as: 'contentCategoryId' + property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation + + property :directory_site_id, :numeric_string => true, as: 'directorySiteId' + property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :external_id, as: 'externalId' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :key_name, as: 'keyName' + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation + + property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV3_0::LookbackConfiguration, decorator: Google::Apis::DfareportingV3_0::LookbackConfiguration::Representation + + property :name, as: 'name' + property :payment_approved, as: 'paymentApproved' + property :payment_source, as: 'paymentSource' + property :placement_group_id, :numeric_string => true, as: 'placementGroupId' + property :placement_group_id_dimension_value, as: 'placementGroupIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :placement_strategy_id, :numeric_string => true, as: 'placementStrategyId' + property :pricing_schedule, as: 'pricingSchedule', class: Google::Apis::DfareportingV3_0::PricingSchedule, decorator: Google::Apis::DfareportingV3_0::PricingSchedule::Representation + + property :primary, as: 'primary' + property :publisher_update_info, as: 'publisherUpdateInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation + + property :site_id, :numeric_string => true, as: 'siteId' + property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :size, as: 'size', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation + + property :ssl_required, as: 'sslRequired' + property :status, as: 'status' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + collection :tag_formats, as: 'tagFormats' + property :tag_setting, as: 'tagSetting', class: Google::Apis::DfareportingV3_0::TagSetting, decorator: Google::Apis::DfareportingV3_0::TagSetting::Representation + + property :video_active_view_opt_out, as: 'videoActiveViewOptOut' + property :video_settings, as: 'videoSettings', class: Google::Apis::DfareportingV3_0::VideoSettings, decorator: Google::Apis::DfareportingV3_0::VideoSettings::Representation + + property :vpaid_adapter_choice, as: 'vpaidAdapterChoice' + end + end + + class PlacementAssignment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :active, as: 'active' + property :placement_id, :numeric_string => true, as: 'placementId' + property :placement_id_dimension_value, as: 'placementIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :ssl_required, as: 'sslRequired' + end + end + + class PlacementGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :archived, as: 'archived' + property :campaign_id, :numeric_string => true, as: 'campaignId' + property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + collection :child_placement_ids, as: 'childPlacementIds' + property :comment, as: 'comment' + property :content_category_id, :numeric_string => true, as: 'contentCategoryId' + property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation + + property :directory_site_id, :numeric_string => true, as: 'directorySiteId' + property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :external_id, as: 'externalId' + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation + + property :name, as: 'name' + property :placement_group_type, as: 'placementGroupType' + property :placement_strategy_id, :numeric_string => true, as: 'placementStrategyId' + property :pricing_schedule, as: 'pricingSchedule', class: Google::Apis::DfareportingV3_0::PricingSchedule, decorator: Google::Apis::DfareportingV3_0::PricingSchedule::Representation + + property :primary_placement_id, :numeric_string => true, as: 'primaryPlacementId' + property :primary_placement_id_dimension_value, as: 'primaryPlacementIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :site_id, :numeric_string => true, as: 'siteId' + property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + end + end + + class PlacementGroupsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :placement_groups, as: 'placementGroups', class: Google::Apis::DfareportingV3_0::PlacementGroup, decorator: Google::Apis::DfareportingV3_0::PlacementGroup::Representation + + end + end + + class PlacementStrategiesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :placement_strategies, as: 'placementStrategies', class: Google::Apis::DfareportingV3_0::PlacementStrategy, decorator: Google::Apis::DfareportingV3_0::PlacementStrategy::Representation + + end + end + + class PlacementStrategy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class PlacementTag + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :placement_id, :numeric_string => true, as: 'placementId' + collection :tag_datas, as: 'tagDatas', class: Google::Apis::DfareportingV3_0::TagData, decorator: Google::Apis::DfareportingV3_0::TagData::Representation + + end + end + + class PlacementsGenerateTagsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :placement_tags, as: 'placementTags', class: Google::Apis::DfareportingV3_0::PlacementTag, decorator: Google::Apis::DfareportingV3_0::PlacementTag::Representation + + end + end + + class PlacementsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :placements, as: 'placements', class: Google::Apis::DfareportingV3_0::Placement, decorator: Google::Apis::DfareportingV3_0::Placement::Representation + + end + end + + class PlatformType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class PlatformTypesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :platform_types, as: 'platformTypes', class: Google::Apis::DfareportingV3_0::PlatformType, decorator: Google::Apis::DfareportingV3_0::PlatformType::Representation + + end + end + + class PopupWindowProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dimension, as: 'dimension', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation + + property :offset, as: 'offset', class: Google::Apis::DfareportingV3_0::OffsetPosition, decorator: Google::Apis::DfareportingV3_0::OffsetPosition::Representation + + property :position_type, as: 'positionType' + property :show_address_bar, as: 'showAddressBar' + property :show_menu_bar, as: 'showMenuBar' + property :show_scroll_bar, as: 'showScrollBar' + property :show_status_bar, as: 'showStatusBar' + property :show_tool_bar, as: 'showToolBar' + property :title, as: 'title' + end + end + + class PostalCode + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + property :country_code, as: 'countryCode' + property :country_dart_id, :numeric_string => true, as: 'countryDartId' + property :id, as: 'id' + property :kind, as: 'kind' + end + end + + class PostalCodesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :postal_codes, as: 'postalCodes', class: Google::Apis::DfareportingV3_0::PostalCode, decorator: Google::Apis::DfareportingV3_0::PostalCode::Representation + + end + end + + class Pricing + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cap_cost_type, as: 'capCostType' + property :end_date, as: 'endDate', type: Date + + collection :flights, as: 'flights', class: Google::Apis::DfareportingV3_0::Flight, decorator: Google::Apis::DfareportingV3_0::Flight::Representation + + property :group_type, as: 'groupType' + property :pricing_type, as: 'pricingType' + property :start_date, as: 'startDate', type: Date + + end + end + + class PricingSchedule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cap_cost_option, as: 'capCostOption' + property :disregard_overdelivery, as: 'disregardOverdelivery' + property :end_date, as: 'endDate', type: Date + + property :flighted, as: 'flighted' + property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' + collection :pricing_periods, as: 'pricingPeriods', class: Google::Apis::DfareportingV3_0::PricingSchedulePricingPeriod, decorator: Google::Apis::DfareportingV3_0::PricingSchedulePricingPeriod::Representation + + property :pricing_type, as: 'pricingType' + property :start_date, as: 'startDate', type: Date + + property :testing_start_date, as: 'testingStartDate', type: Date + + end + end + + class PricingSchedulePricingPeriod + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_date, as: 'endDate', type: Date + + property :pricing_comment, as: 'pricingComment' + property :rate_or_cost_nanos, :numeric_string => true, as: 'rateOrCostNanos' + property :start_date, as: 'startDate', type: Date + + property :units, :numeric_string => true, as: 'units' + end + end + + class Project + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :audience_age_group, as: 'audienceAgeGroup' + property :audience_gender, as: 'audienceGender' + property :budget, :numeric_string => true, as: 'budget' + property :client_billing_code, as: 'clientBillingCode' + property :client_name, as: 'clientName' + property :end_date, as: 'endDate', type: Date + + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV3_0::LastModifiedInfo, decorator: Google::Apis::DfareportingV3_0::LastModifiedInfo::Representation + + property :name, as: 'name' + property :overview, as: 'overview' + property :start_date, as: 'startDate', type: Date + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :target_clicks, :numeric_string => true, as: 'targetClicks' + property :target_conversions, :numeric_string => true, as: 'targetConversions' + property :target_cpa_nanos, :numeric_string => true, as: 'targetCpaNanos' + property :target_cpc_nanos, :numeric_string => true, as: 'targetCpcNanos' + property :target_cpm_active_view_nanos, :numeric_string => true, as: 'targetCpmActiveViewNanos' + property :target_cpm_nanos, :numeric_string => true, as: 'targetCpmNanos' + property :target_impressions, :numeric_string => true, as: 'targetImpressions' + end + end + + class ProjectsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :projects, as: 'projects', class: Google::Apis::DfareportingV3_0::Project, decorator: Google::Apis::DfareportingV3_0::Project::Representation + + end + end + + class ReachReportCompatibleFields + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation + + collection :pivoted_activity_metrics, as: 'pivotedActivityMetrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation + + collection :reach_by_frequency_metrics, as: 'reachByFrequencyMetrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation + + end + end + + class Recipient + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :delivery_type, as: 'deliveryType' + property :email, as: 'email' + property :kind, as: 'kind' + end + end + + class Region + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :country_code, as: 'countryCode' + property :country_dart_id, :numeric_string => true, as: 'countryDartId' + property :dart_id, :numeric_string => true, as: 'dartId' + property :kind, as: 'kind' + property :name, as: 'name' + property :region_code, as: 'regionCode' + end + end + + class RegionsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :regions, as: 'regions', class: Google::Apis::DfareportingV3_0::Region, decorator: Google::Apis::DfareportingV3_0::Region::Representation + + end + end + + class RemarketingList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :active, as: 'active' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :description, as: 'description' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :life_span, :numeric_string => true, as: 'lifeSpan' + property :list_population_rule, as: 'listPopulationRule', class: Google::Apis::DfareportingV3_0::ListPopulationRule, decorator: Google::Apis::DfareportingV3_0::ListPopulationRule::Representation + + property :list_size, :numeric_string => true, as: 'listSize' + property :list_source, as: 'listSource' + property :name, as: 'name' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + end + end + + class RemarketingListShare + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :remarketing_list_id, :numeric_string => true, as: 'remarketingListId' + collection :shared_account_ids, as: 'sharedAccountIds' + collection :shared_advertiser_ids, as: 'sharedAdvertiserIds' + end + end + + class RemarketingListsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :remarketing_lists, as: 'remarketingLists', class: Google::Apis::DfareportingV3_0::RemarketingList, decorator: Google::Apis::DfareportingV3_0::RemarketingList::Representation + + end + end + + class Report + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :criteria, as: 'criteria', class: Google::Apis::DfareportingV3_0::Report::Criteria, decorator: Google::Apis::DfareportingV3_0::Report::Criteria::Representation + + property :cross_dimension_reach_criteria, as: 'crossDimensionReachCriteria', class: Google::Apis::DfareportingV3_0::Report::CrossDimensionReachCriteria, decorator: Google::Apis::DfareportingV3_0::Report::CrossDimensionReachCriteria::Representation + + property :delivery, as: 'delivery', class: Google::Apis::DfareportingV3_0::Report::Delivery, decorator: Google::Apis::DfareportingV3_0::Report::Delivery::Representation + + property :etag, as: 'etag' + property :file_name, as: 'fileName' + property :floodlight_criteria, as: 'floodlightCriteria', class: Google::Apis::DfareportingV3_0::Report::FloodlightCriteria, decorator: Google::Apis::DfareportingV3_0::Report::FloodlightCriteria::Representation + + property :format, as: 'format' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :last_modified_time, :numeric_string => true, as: 'lastModifiedTime' + property :name, as: 'name' + property :owner_profile_id, :numeric_string => true, as: 'ownerProfileId' + property :path_to_conversion_criteria, as: 'pathToConversionCriteria', class: Google::Apis::DfareportingV3_0::Report::PathToConversionCriteria, decorator: Google::Apis::DfareportingV3_0::Report::PathToConversionCriteria::Representation + + property :reach_criteria, as: 'reachCriteria', class: Google::Apis::DfareportingV3_0::Report::ReachCriteria, decorator: Google::Apis::DfareportingV3_0::Report::ReachCriteria::Representation + + property :schedule, as: 'schedule', class: Google::Apis::DfareportingV3_0::Report::Schedule, decorator: Google::Apis::DfareportingV3_0::Report::Schedule::Representation + + property :sub_account_id, :numeric_string => true, as: 'subAccountId' + property :type, as: 'type' + end + + class Criteria + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :activities, as: 'activities', class: Google::Apis::DfareportingV3_0::Activities, decorator: Google::Apis::DfareportingV3_0::Activities::Representation + + property :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV3_0::CustomRichMediaEvents, decorator: Google::Apis::DfareportingV3_0::CustomRichMediaEvents::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_0::DateRange, decorator: Google::Apis::DfareportingV3_0::DateRange::Representation + + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_0::SortedDimension, decorator: Google::Apis::DfareportingV3_0::SortedDimension::Representation + + collection :metric_names, as: 'metricNames' + end + end + + class CrossDimensionReachCriteria + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :breakdown, as: 'breakdown', class: Google::Apis::DfareportingV3_0::SortedDimension, decorator: Google::Apis::DfareportingV3_0::SortedDimension::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_0::DateRange, decorator: Google::Apis::DfareportingV3_0::DateRange::Representation + + property :dimension, as: 'dimension' + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + collection :metric_names, as: 'metricNames' + collection :overlap_metric_names, as: 'overlapMetricNames' + property :pivoted, as: 'pivoted' + end + end + + class Delivery + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :email_owner, as: 'emailOwner' + property :email_owner_delivery_type, as: 'emailOwnerDeliveryType' + property :message, as: 'message' + collection :recipients, as: 'recipients', class: Google::Apis::DfareportingV3_0::Recipient, decorator: Google::Apis::DfareportingV3_0::Recipient::Representation + + end + end + + class FloodlightCriteria + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_0::DateRange, decorator: Google::Apis::DfareportingV3_0::DateRange::Representation + + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_0::SortedDimension, decorator: Google::Apis::DfareportingV3_0::SortedDimension::Representation + + property :floodlight_config_id, as: 'floodlightConfigId', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + collection :metric_names, as: 'metricNames' + property :report_properties, as: 'reportProperties', class: Google::Apis::DfareportingV3_0::Report::FloodlightCriteria::ReportProperties, decorator: Google::Apis::DfareportingV3_0::Report::FloodlightCriteria::ReportProperties::Representation + + end + + class ReportProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :include_attributed_ip_conversions, as: 'includeAttributedIPConversions' + property :include_unattributed_cookie_conversions, as: 'includeUnattributedCookieConversions' + property :include_unattributed_ip_conversions, as: 'includeUnattributedIPConversions' + end + end + end + + class PathToConversionCriteria + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :activity_filters, as: 'activityFilters', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + collection :conversion_dimensions, as: 'conversionDimensions', class: Google::Apis::DfareportingV3_0::SortedDimension, decorator: Google::Apis::DfareportingV3_0::SortedDimension::Representation + + collection :custom_floodlight_variables, as: 'customFloodlightVariables', class: Google::Apis::DfareportingV3_0::SortedDimension, decorator: Google::Apis::DfareportingV3_0::SortedDimension::Representation + + collection :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_0::DateRange, decorator: Google::Apis::DfareportingV3_0::DateRange::Representation + + property :floodlight_config_id, as: 'floodlightConfigId', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + collection :metric_names, as: 'metricNames' + collection :per_interaction_dimensions, as: 'perInteractionDimensions', class: Google::Apis::DfareportingV3_0::SortedDimension, decorator: Google::Apis::DfareportingV3_0::SortedDimension::Representation + + property :report_properties, as: 'reportProperties', class: Google::Apis::DfareportingV3_0::Report::PathToConversionCriteria::ReportProperties, decorator: Google::Apis::DfareportingV3_0::Report::PathToConversionCriteria::ReportProperties::Representation + + end + + class ReportProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :clicks_lookback_window, as: 'clicksLookbackWindow' + property :impressions_lookback_window, as: 'impressionsLookbackWindow' + property :include_attributed_ip_conversions, as: 'includeAttributedIPConversions' + property :include_unattributed_cookie_conversions, as: 'includeUnattributedCookieConversions' + property :include_unattributed_ip_conversions, as: 'includeUnattributedIPConversions' + property :maximum_click_interactions, as: 'maximumClickInteractions' + property :maximum_impression_interactions, as: 'maximumImpressionInteractions' + property :maximum_interaction_gap, as: 'maximumInteractionGap' + property :pivot_on_interaction_path, as: 'pivotOnInteractionPath' + end + end + end + + class ReachCriteria + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :activities, as: 'activities', class: Google::Apis::DfareportingV3_0::Activities, decorator: Google::Apis::DfareportingV3_0::Activities::Representation + + property :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV3_0::CustomRichMediaEvents, decorator: Google::Apis::DfareportingV3_0::CustomRichMediaEvents::Representation + + property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV3_0::DateRange, decorator: Google::Apis::DfareportingV3_0::DateRange::Representation + + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_0::SortedDimension, decorator: Google::Apis::DfareportingV3_0::SortedDimension::Representation + + property :enable_all_dimension_combinations, as: 'enableAllDimensionCombinations' + collection :metric_names, as: 'metricNames' + collection :reach_by_frequency_metric_names, as: 'reachByFrequencyMetricNames' + end + end + + class Schedule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :active, as: 'active' + property :every, as: 'every' + property :expiration_date, as: 'expirationDate', type: Date + + property :repeats, as: 'repeats' + collection :repeats_on_week_days, as: 'repeatsOnWeekDays' + property :runs_on_day_of_month, as: 'runsOnDayOfMonth' + property :start_date, as: 'startDate', type: Date + + end + end + end + + class ReportCompatibleFields + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation + + collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV3_0::Dimension, decorator: Google::Apis::DfareportingV3_0::Dimension::Representation + + property :kind, as: 'kind' + collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation + + collection :pivoted_activity_metrics, as: 'pivotedActivityMetrics', class: Google::Apis::DfareportingV3_0::Metric, decorator: Google::Apis::DfareportingV3_0::Metric::Representation + + end + end + + class ReportList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + collection :items, as: 'items', class: Google::Apis::DfareportingV3_0::Report, decorator: Google::Apis::DfareportingV3_0::Report::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class ReportsConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :exposure_to_conversion_enabled, as: 'exposureToConversionEnabled' + property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV3_0::LookbackConfiguration, decorator: Google::Apis::DfareportingV3_0::LookbackConfiguration::Representation + + property :report_generation_time_zone_id, :numeric_string => true, as: 'reportGenerationTimeZoneId' + end + end + + class RichMediaExitOverride + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV3_0::ClickThroughUrl, decorator: Google::Apis::DfareportingV3_0::ClickThroughUrl::Representation + + property :enabled, as: 'enabled' + property :exit_id, :numeric_string => true, as: 'exitId' + end + end + + class Rule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :asset_id, :numeric_string => true, as: 'assetId' + property :name, as: 'name' + property :targeting_template_id, :numeric_string => true, as: 'targetingTemplateId' + end + end + + class Site + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :approved, as: 'approved' + property :directory_site_id, :numeric_string => true, as: 'directorySiteId' + property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :id, :numeric_string => true, as: 'id' + property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :key_name, as: 'keyName' + property :kind, as: 'kind' + property :name, as: 'name' + collection :site_contacts, as: 'siteContacts', class: Google::Apis::DfareportingV3_0::SiteContact, decorator: Google::Apis::DfareportingV3_0::SiteContact::Representation + + property :site_settings, as: 'siteSettings', class: Google::Apis::DfareportingV3_0::SiteSettings, decorator: Google::Apis::DfareportingV3_0::SiteSettings::Representation + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + end + end + + class SiteContact + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :address, as: 'address' + property :contact_type, as: 'contactType' + property :email, as: 'email' + property :first_name, as: 'firstName' + property :id, :numeric_string => true, as: 'id' + property :last_name, as: 'lastName' + property :phone, as: 'phone' + property :title, as: 'title' + end + end + + class SiteSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :active_view_opt_out, as: 'activeViewOptOut' + property :ad_blocking_opt_out, as: 'adBlockingOptOut' + property :creative_settings, as: 'creativeSettings', class: Google::Apis::DfareportingV3_0::CreativeSettings, decorator: Google::Apis::DfareportingV3_0::CreativeSettings::Representation + + property :disable_new_cookie, as: 'disableNewCookie' + property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV3_0::LookbackConfiguration, decorator: Google::Apis::DfareportingV3_0::LookbackConfiguration::Representation + + property :tag_setting, as: 'tagSetting', class: Google::Apis::DfareportingV3_0::TagSetting, decorator: Google::Apis::DfareportingV3_0::TagSetting::Representation + + property :video_active_view_opt_out_template, as: 'videoActiveViewOptOutTemplate' + property :vpaid_adapter_choice_template, as: 'vpaidAdapterChoiceTemplate' + end + end + + class SitesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :sites, as: 'sites', class: Google::Apis::DfareportingV3_0::Site, decorator: Google::Apis::DfareportingV3_0::Site::Representation + + end + end + + class Size + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :height, as: 'height' + property :iab, as: 'iab' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :width, as: 'width' + end + end + + class SizesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :sizes, as: 'sizes', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation + + end + end + + class SkippableSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :progress_offset, as: 'progressOffset', class: Google::Apis::DfareportingV3_0::VideoOffset, decorator: Google::Apis::DfareportingV3_0::VideoOffset::Representation + + property :skip_offset, as: 'skipOffset', class: Google::Apis::DfareportingV3_0::VideoOffset, decorator: Google::Apis::DfareportingV3_0::VideoOffset::Representation + + property :skippable, as: 'skippable' + end + end + + class SortedDimension + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :name, as: 'name' + property :sort_order, as: 'sortOrder' + end + end + + class Subaccount + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + collection :available_permission_ids, as: 'availablePermissionIds' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class SubaccountsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :subaccounts, as: 'subaccounts', class: Google::Apis::DfareportingV3_0::Subaccount, decorator: Google::Apis::DfareportingV3_0::Subaccount::Representation + + end + end + + class TagData + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ad_id, :numeric_string => true, as: 'adId' + property :click_tag, as: 'clickTag' + property :creative_id, :numeric_string => true, as: 'creativeId' + property :format, as: 'format' + property :impression_tag, as: 'impressionTag' + end + end + + class TagSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :additional_key_values, as: 'additionalKeyValues' + property :include_click_through_urls, as: 'includeClickThroughUrls' + property :include_click_tracking, as: 'includeClickTracking' + property :keyword_option, as: 'keywordOption' + end + end + + class TagSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dynamic_tag_enabled, as: 'dynamicTagEnabled' + property :image_tag_enabled, as: 'imageTagEnabled' + end + end + + class TargetWindow + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :custom_html, as: 'customHtml' + property :target_window_option, as: 'targetWindowOption' + end + end + + class TargetableRemarketingList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :active, as: 'active' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :description, as: 'description' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :life_span, :numeric_string => true, as: 'lifeSpan' + property :list_size, :numeric_string => true, as: 'listSize' + property :list_source, as: 'listSource' + property :name, as: 'name' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + end + end + + class TargetableRemarketingListsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :targetable_remarketing_lists, as: 'targetableRemarketingLists', class: Google::Apis::DfareportingV3_0::TargetableRemarketingList, decorator: Google::Apis::DfareportingV3_0::TargetableRemarketingList::Representation + + end + end + + class TargetingTemplate + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :advertiser_id_dimension_value, as: 'advertiserIdDimensionValue', class: Google::Apis::DfareportingV3_0::DimensionValue, decorator: Google::Apis::DfareportingV3_0::DimensionValue::Representation + + property :day_part_targeting, as: 'dayPartTargeting', class: Google::Apis::DfareportingV3_0::DayPartTargeting, decorator: Google::Apis::DfareportingV3_0::DayPartTargeting::Representation + + property :geo_targeting, as: 'geoTargeting', class: Google::Apis::DfareportingV3_0::GeoTargeting, decorator: Google::Apis::DfareportingV3_0::GeoTargeting::Representation + + property :id, :numeric_string => true, as: 'id' + property :key_value_targeting_expression, as: 'keyValueTargetingExpression', class: Google::Apis::DfareportingV3_0::KeyValueTargetingExpression, decorator: Google::Apis::DfareportingV3_0::KeyValueTargetingExpression::Representation + + property :kind, as: 'kind' + property :language_targeting, as: 'languageTargeting', class: Google::Apis::DfareportingV3_0::LanguageTargeting, decorator: Google::Apis::DfareportingV3_0::LanguageTargeting::Representation + + property :list_targeting_expression, as: 'listTargetingExpression', class: Google::Apis::DfareportingV3_0::ListTargetingExpression, decorator: Google::Apis::DfareportingV3_0::ListTargetingExpression::Representation + + property :name, as: 'name' + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + property :technology_targeting, as: 'technologyTargeting', class: Google::Apis::DfareportingV3_0::TechnologyTargeting, decorator: Google::Apis::DfareportingV3_0::TechnologyTargeting::Representation + + end + end + + class TargetingTemplatesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :targeting_templates, as: 'targetingTemplates', class: Google::Apis::DfareportingV3_0::TargetingTemplate, decorator: Google::Apis::DfareportingV3_0::TargetingTemplate::Representation + + end + end + + class TechnologyTargeting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :browsers, as: 'browsers', class: Google::Apis::DfareportingV3_0::Browser, decorator: Google::Apis::DfareportingV3_0::Browser::Representation + + collection :connection_types, as: 'connectionTypes', class: Google::Apis::DfareportingV3_0::ConnectionType, decorator: Google::Apis::DfareportingV3_0::ConnectionType::Representation + + collection :mobile_carriers, as: 'mobileCarriers', class: Google::Apis::DfareportingV3_0::MobileCarrier, decorator: Google::Apis::DfareportingV3_0::MobileCarrier::Representation + + collection :operating_system_versions, as: 'operatingSystemVersions', class: Google::Apis::DfareportingV3_0::OperatingSystemVersion, decorator: Google::Apis::DfareportingV3_0::OperatingSystemVersion::Representation + + collection :operating_systems, as: 'operatingSystems', class: Google::Apis::DfareportingV3_0::OperatingSystem, decorator: Google::Apis::DfareportingV3_0::OperatingSystem::Representation + + collection :platform_types, as: 'platformTypes', class: Google::Apis::DfareportingV3_0::PlatformType, decorator: Google::Apis::DfareportingV3_0::PlatformType::Representation + + end + end + + class ThirdPartyAuthenticationToken + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :value, as: 'value' + end + end + + class ThirdPartyTrackingUrl + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :third_party_url_type, as: 'thirdPartyUrlType' + property :url, as: 'url' + end + end + + class TranscodeSetting + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :enabled_video_formats, as: 'enabledVideoFormats' + property :kind, as: 'kind' + end + end + + class UniversalAdId + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :registry, as: 'registry' + property :value, as: 'value' + end + end + + class UserDefinedVariableConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :data_type, as: 'dataType' + property :report_name, as: 'reportName' + property :variable_type, as: 'variableType' + end + end + + class UserProfile + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :account_name, as: 'accountName' + property :etag, as: 'etag' + property :kind, as: 'kind' + property :profile_id, :numeric_string => true, as: 'profileId' + property :sub_account_id, :numeric_string => true, as: 'subAccountId' + property :sub_account_name, as: 'subAccountName' + property :user_name, as: 'userName' + end + end + + class UserProfileList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + collection :items, as: 'items', class: Google::Apis::DfareportingV3_0::UserProfile, decorator: Google::Apis::DfareportingV3_0::UserProfile::Representation + + property :kind, as: 'kind' + end + end + + class UserRole + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :default_user_role, as: 'defaultUserRole' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :parent_user_role_id, :numeric_string => true, as: 'parentUserRoleId' + collection :permissions, as: 'permissions', class: Google::Apis::DfareportingV3_0::UserRolePermission, decorator: Google::Apis::DfareportingV3_0::UserRolePermission::Representation + + property :subaccount_id, :numeric_string => true, as: 'subaccountId' + end + end + + class UserRolePermission + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :availability, as: 'availability' + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :permission_group_id, :numeric_string => true, as: 'permissionGroupId' + end + end + + class UserRolePermissionGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class UserRolePermissionGroupsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :user_role_permission_groups, as: 'userRolePermissionGroups', class: Google::Apis::DfareportingV3_0::UserRolePermissionGroup, decorator: Google::Apis::DfareportingV3_0::UserRolePermissionGroup::Representation + + end + end + + class UserRolePermissionsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :user_role_permissions, as: 'userRolePermissions', class: Google::Apis::DfareportingV3_0::UserRolePermission, decorator: Google::Apis::DfareportingV3_0::UserRolePermission::Representation + + end + end + + class UserRolesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :user_roles, as: 'userRoles', class: Google::Apis::DfareportingV3_0::UserRole, decorator: Google::Apis::DfareportingV3_0::UserRole::Representation + + end + end + + class VideoFormat + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :file_type, as: 'fileType' + property :id, as: 'id' + property :kind, as: 'kind' + property :resolution, as: 'resolution', class: Google::Apis::DfareportingV3_0::Size, decorator: Google::Apis::DfareportingV3_0::Size::Representation + + property :target_bit_rate, as: 'targetBitRate' + end + end + + class VideoFormatsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + collection :video_formats, as: 'videoFormats', class: Google::Apis::DfareportingV3_0::VideoFormat, decorator: Google::Apis::DfareportingV3_0::VideoFormat::Representation + + end + end + + class VideoOffset + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :offset_percentage, as: 'offsetPercentage' + property :offset_seconds, as: 'offsetSeconds' + end + end + + class VideoSettings + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :companion_settings, as: 'companionSettings', class: Google::Apis::DfareportingV3_0::CompanionSetting, decorator: Google::Apis::DfareportingV3_0::CompanionSetting::Representation + + property :kind, as: 'kind' + property :orientation, as: 'orientation' + property :skippable_settings, as: 'skippableSettings', class: Google::Apis::DfareportingV3_0::SkippableSetting, decorator: Google::Apis::DfareportingV3_0::SkippableSetting::Representation + + property :transcode_settings, as: 'transcodeSettings', class: Google::Apis::DfareportingV3_0::TranscodeSetting, decorator: Google::Apis::DfareportingV3_0::TranscodeSetting::Representation + + end + end + end + end +end diff --git a/generated/google/apis/dfareporting_v3_0/service.rb b/generated/google/apis/dfareporting_v3_0/service.rb new file mode 100644 index 000000000..928fcea86 --- /dev/null +++ b/generated/google/apis/dfareporting_v3_0/service.rb @@ -0,0 +1,9108 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DfareportingV3_0 + # DCM/DFA Reporting And Trafficking API + # + # Manages your DoubleClick Campaign Manager ad campaigns and reports. + # + # @example + # require 'google/apis/dfareporting_v3_0' + # + # Dfareporting = Google::Apis::DfareportingV3_0 # Alias the module + # service = Dfareporting::DfareportingService.new + # + # @see https://developers.google.com/doubleclick-advertisers/ + class DfareportingService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + # Overrides userIp if both are provided. + attr_accessor :quota_user + + # @return [String] + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + attr_accessor :user_ip + + def initialize + super('https://www.googleapis.com/', 'dfareporting/v3.0/') + @batch_path = 'batch/dfareporting/v3.0' + end + + # Gets the account's active ad summary by account ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] summary_account_id + # Account ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AccountActiveAdSummary] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AccountActiveAdSummary] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_account_active_ad_summary(profile_id, summary_account_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}', options) + command.response_representation = Google::Apis::DfareportingV3_0::AccountActiveAdSummary::Representation + command.response_class = Google::Apis::DfareportingV3_0::AccountActiveAdSummary + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['summaryAccountId'] = summary_account_id unless summary_account_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one account permission group by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Account permission group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AccountPermissionGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AccountPermissionGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_account_permission_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissionGroups/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::AccountPermissionGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::AccountPermissionGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of account permission groups. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AccountPermissionGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AccountPermissionGroupsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_account_permission_groups(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissionGroups', options) + command.response_representation = Google::Apis::DfareportingV3_0::AccountPermissionGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::AccountPermissionGroupsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one account permission by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Account permission ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AccountPermission] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AccountPermission] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_account_permission(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissions/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::AccountPermission::Representation + command.response_class = Google::Apis::DfareportingV3_0::AccountPermission + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of account permissions. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AccountPermissionsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AccountPermissionsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_account_permissions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accountPermissions', options) + command.response_representation = Google::Apis::DfareportingV3_0::AccountPermissionsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::AccountPermissionsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one account user profile by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # User profile ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AccountUserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AccountUserProfile] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_account_user_profile(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accountUserProfiles/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation + command.response_class = Google::Apis::DfareportingV3_0::AccountUserProfile + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new account user profile. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::AccountUserProfile] account_user_profile_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AccountUserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AccountUserProfile] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_account_user_profile(profile_id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/accountUserProfiles', options) + command.request_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation + command.request_object = account_user_profile_object + command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation + command.response_class = Google::Apis::DfareportingV3_0::AccountUserProfile + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of account user profiles, possibly filtered. This method + # supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Boolean] active + # Select only active user profiles. + # @param [Array, Fixnum] ids + # Select only user profiles with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name, ID or email. Wildcards (*) are allowed. + # For example, "user profile*2015" will return objects with names like "user + # profile June 2015", "user profile April 2015", or simply "user profile 2015". + # Most of the searches also add wildcards implicitly at the start and the end of + # the search string. For example, a search string of "user profile" will match + # objects with name "my user profile", "user profile 2015", or simply "user + # profile". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [Fixnum] subaccount_id + # Select only user profiles with the specified subaccount ID. + # @param [Fixnum] user_role_id + # Select only user profiles with the specified user role ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AccountUserProfilesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AccountUserProfilesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_account_user_profiles(profile_id, active: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, user_role_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accountUserProfiles', options) + command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfilesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::AccountUserProfilesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['active'] = active unless active.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? + command.query['userRoleId'] = user_role_id unless user_role_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing account user profile. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # User profile ID. + # @param [Google::Apis::DfareportingV3_0::AccountUserProfile] account_user_profile_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AccountUserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AccountUserProfile] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_account_user_profile(profile_id, id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/accountUserProfiles', options) + command.request_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation + command.request_object = account_user_profile_object + command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation + command.response_class = Google::Apis::DfareportingV3_0::AccountUserProfile + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing account user profile. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::AccountUserProfile] account_user_profile_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AccountUserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AccountUserProfile] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_account_user_profile(profile_id, account_user_profile_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/accountUserProfiles', options) + command.request_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation + command.request_object = account_user_profile_object + command.response_representation = Google::Apis::DfareportingV3_0::AccountUserProfile::Representation + command.response_class = Google::Apis::DfareportingV3_0::AccountUserProfile + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one account by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Account ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Account] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Account] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_account(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accounts/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::Account::Representation + command.response_class = Google::Apis::DfareportingV3_0::Account + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of accounts, possibly filtered. This method supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Boolean] active + # Select only active accounts. Don't set this field to select both active and + # non-active accounts. + # @param [Array, Fixnum] ids + # Select only accounts with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "account*2015" will return objects with names like "account June 2015" + # , "account April 2015", or simply "account 2015". Most of the searches also + # add wildcards implicitly at the start and the end of the search string. For + # example, a search string of "account" will match objects with name "my account" + # , "account 2015", or simply "account". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AccountsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AccountsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_accounts(profile_id, active: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/accounts', options) + command.response_representation = Google::Apis::DfareportingV3_0::AccountsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::AccountsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['active'] = active unless active.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing account. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Account ID. + # @param [Google::Apis::DfareportingV3_0::Account] account_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Account] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Account] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_account(profile_id, id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/accounts', options) + command.request_representation = Google::Apis::DfareportingV3_0::Account::Representation + command.request_object = account_object + command.response_representation = Google::Apis::DfareportingV3_0::Account::Representation + command.response_class = Google::Apis::DfareportingV3_0::Account + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing account. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Account] account_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Account] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Account] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_account(profile_id, account_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/accounts', options) + command.request_representation = Google::Apis::DfareportingV3_0::Account::Representation + command.request_object = account_object + command.response_representation = Google::Apis::DfareportingV3_0::Account::Representation + command.response_class = Google::Apis::DfareportingV3_0::Account + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one ad by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Ad ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Ad] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Ad] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_ad(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/ads/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::Ad::Representation + command.response_class = Google::Apis::DfareportingV3_0::Ad + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new ad. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Ad] ad_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Ad] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Ad] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/ads', options) + command.request_representation = Google::Apis::DfareportingV3_0::Ad::Representation + command.request_object = ad_object + command.response_representation = Google::Apis::DfareportingV3_0::Ad::Representation + command.response_class = Google::Apis::DfareportingV3_0::Ad + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of ads, possibly filtered. This method supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Boolean] active + # Select only active ads. + # @param [Fixnum] advertiser_id + # Select only ads with this advertiser ID. + # @param [Boolean] archived + # Select only archived ads. + # @param [Array, Fixnum] audience_segment_ids + # Select only ads with these audience segment IDs. + # @param [Array, Fixnum] campaign_ids + # Select only ads with these campaign IDs. + # @param [String] compatibility + # Select default ads with the specified compatibility. Applicable when type is + # AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering + # either on desktop or on mobile devices for regular or interstitial ads, + # respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. + # IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the + # VAST standard. + # @param [Array, Fixnum] creative_ids + # Select only ads with these creative IDs assigned. + # @param [Array, Fixnum] creative_optimization_configuration_ids + # Select only ads with these creative optimization configuration IDs. + # @param [Boolean] dynamic_click_tracker + # Select only dynamic click trackers. Applicable when type is + # AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, + # select static click trackers. Leave unset to select both. + # @param [Array, Fixnum] ids + # Select only ads with these IDs. + # @param [Array, Fixnum] landing_page_ids + # Select only ads with these landing page IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [Fixnum] overridden_event_tag_id + # Select only ads with this event tag override ID. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [Array, Fixnum] placement_ids + # Select only ads with these placement IDs assigned. + # @param [Array, Fixnum] remarketing_list_ids + # Select only ads whose list targeting expression use these remarketing list IDs. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "ad*2015" will return objects with names like "ad June 2015", "ad + # April 2015", or simply "ad 2015". Most of the searches also add wildcards + # implicitly at the start and the end of the search string. For example, a + # search string of "ad" will match objects with name "my ad", "ad 2015", or + # simply "ad". + # @param [Array, Fixnum] size_ids + # Select only ads with these size IDs. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [Boolean] ssl_compliant + # Select only ads that are SSL-compliant. + # @param [Boolean] ssl_required + # Select only ads that require SSL. + # @param [Array, String] type + # Select only ads with these types. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AdsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AdsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_ads(profile_id, active: nil, advertiser_id: nil, archived: nil, audience_segment_ids: nil, campaign_ids: nil, compatibility: nil, creative_ids: nil, creative_optimization_configuration_ids: nil, dynamic_click_tracker: nil, ids: nil, landing_page_ids: nil, max_results: nil, overridden_event_tag_id: nil, page_token: nil, placement_ids: nil, remarketing_list_ids: nil, search_string: nil, size_ids: nil, sort_field: nil, sort_order: nil, ssl_compliant: nil, ssl_required: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/ads', options) + command.response_representation = Google::Apis::DfareportingV3_0::AdsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::AdsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['active'] = active unless active.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['archived'] = archived unless archived.nil? + command.query['audienceSegmentIds'] = audience_segment_ids unless audience_segment_ids.nil? + command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? + command.query['compatibility'] = compatibility unless compatibility.nil? + command.query['creativeIds'] = creative_ids unless creative_ids.nil? + command.query['creativeOptimizationConfigurationIds'] = creative_optimization_configuration_ids unless creative_optimization_configuration_ids.nil? + command.query['dynamicClickTracker'] = dynamic_click_tracker unless dynamic_click_tracker.nil? + command.query['ids'] = ids unless ids.nil? + command.query['landingPageIds'] = landing_page_ids unless landing_page_ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['overriddenEventTagId'] = overridden_event_tag_id unless overridden_event_tag_id.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['placementIds'] = placement_ids unless placement_ids.nil? + command.query['remarketingListIds'] = remarketing_list_ids unless remarketing_list_ids.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sizeIds'] = size_ids unless size_ids.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['sslCompliant'] = ssl_compliant unless ssl_compliant.nil? + command.query['sslRequired'] = ssl_required unless ssl_required.nil? + command.query['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing ad. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Ad ID. + # @param [Google::Apis::DfareportingV3_0::Ad] ad_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Ad] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Ad] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_ad(profile_id, id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/ads', options) + command.request_representation = Google::Apis::DfareportingV3_0::Ad::Representation + command.request_object = ad_object + command.response_representation = Google::Apis::DfareportingV3_0::Ad::Representation + command.response_class = Google::Apis::DfareportingV3_0::Ad + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing ad. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Ad] ad_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Ad] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Ad] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_ad(profile_id, ad_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/ads', options) + command.request_representation = Google::Apis::DfareportingV3_0::Ad::Representation + command.request_object = ad_object + command.response_representation = Google::Apis::DfareportingV3_0::Ad::Representation + command.response_class = Google::Apis::DfareportingV3_0::Ad + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing advertiser group. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Advertiser group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_advertiser_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/advertiserGroups/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one advertiser group by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Advertiser group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AdvertiserGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AdvertiserGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserGroups/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::AdvertiserGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new advertiser group. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::AdvertiserGroup] advertiser_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AdvertiserGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AdvertiserGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/advertiserGroups', options) + command.request_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation + command.request_object = advertiser_group_object + command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::AdvertiserGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of advertiser groups, possibly filtered. This method supports + # paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] ids + # Select only advertiser groups with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "advertiser*2015" will return objects with names like "advertiser + # group June 2015", "advertiser group April 2015", or simply "advertiser group + # 2015". Most of the searches also add wildcards implicitly at the start and the + # end of the search string. For example, a search string of "advertisergroup" + # will match objects with name "my advertisergroup", "advertisergroup 2015", or + # simply "advertisergroup". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AdvertiserGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AdvertiserGroupsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertiser_groups(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserGroups', options) + command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::AdvertiserGroupsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing advertiser group. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Advertiser group ID. + # @param [Google::Apis::DfareportingV3_0::AdvertiserGroup] advertiser_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AdvertiserGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AdvertiserGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_advertiser_group(profile_id, id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/advertiserGroups', options) + command.request_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation + command.request_object = advertiser_group_object + command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::AdvertiserGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing advertiser group. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::AdvertiserGroup] advertiser_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AdvertiserGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AdvertiserGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_advertiser_group(profile_id, advertiser_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/advertiserGroups', options) + command.request_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation + command.request_object = advertiser_group_object + command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::AdvertiserGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one landing page by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Landing page ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::LandingPage] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::LandingPage] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser_landing_page(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserLandingPages/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation + command.response_class = Google::Apis::DfareportingV3_0::LandingPage + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new landing page. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::LandingPage] landing_page_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::LandingPage] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::LandingPage] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_advertiser_landing_page(profile_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/advertiserLandingPages', options) + command.request_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation + command.request_object = landing_page_object + command.response_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation + command.response_class = Google::Apis::DfareportingV3_0::LandingPage + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of landing pages. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] advertiser_ids + # Select only landing pages that belong to these advertisers. + # @param [Boolean] archived + # Select only archived landing pages. Don't set this field to select both + # archived and non-archived landing pages. + # @param [Array, Fixnum] ids + # Select only landing pages with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for landing pages by name or ID. Wildcards (*) are allowed. + # For example, "landingpage*2017" will return landing pages with names like " + # landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". + # Most of the searches also add wildcards implicitly at the start and the end + # of the search string. For example, a search string of "landingpage" will match + # campaigns with name "my landingpage", "landingpage 2015", or simply " + # landingpage". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [Fixnum] subaccount_id + # Select only landing pages that belong to this subaccount. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AdvertiserLandingPagesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AdvertiserLandingPagesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertiser_landing_pages(profile_id, advertiser_ids: nil, archived: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/advertiserLandingPages', options) + command.response_representation = Google::Apis::DfareportingV3_0::AdvertiserLandingPagesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::AdvertiserLandingPagesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? + command.query['archived'] = archived unless archived.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing landing page. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Landing page ID. + # @param [Google::Apis::DfareportingV3_0::LandingPage] landing_page_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::LandingPage] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::LandingPage] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_advertiser_landing_page(profile_id, id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/advertiserLandingPages', options) + command.request_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation + command.request_object = landing_page_object + command.response_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation + command.response_class = Google::Apis::DfareportingV3_0::LandingPage + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing landing page. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::LandingPage] landing_page_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::LandingPage] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::LandingPage] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_advertiser_landing_page(profile_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/advertiserLandingPages', options) + command.request_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation + command.request_object = landing_page_object + command.response_representation = Google::Apis::DfareportingV3_0::LandingPage::Representation + command.response_class = Google::Apis::DfareportingV3_0::LandingPage + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one advertiser by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Advertiser ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Advertiser] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/advertisers/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation + command.response_class = Google::Apis::DfareportingV3_0::Advertiser + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new advertiser. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Advertiser] advertiser_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Advertiser] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_advertiser(profile_id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/advertisers', options) + command.request_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation + command.request_object = advertiser_object + command.response_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation + command.response_class = Google::Apis::DfareportingV3_0::Advertiser + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of advertisers, possibly filtered. This method supports + # paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] advertiser_group_ids + # Select only advertisers with these advertiser group IDs. + # @param [Array, Fixnum] floodlight_configuration_ids + # Select only advertisers with these floodlight configuration IDs. + # @param [Array, Fixnum] ids + # Select only advertisers with these IDs. + # @param [Boolean] include_advertisers_without_groups_only + # Select only advertisers which do not belong to any advertiser group. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [Boolean] only_parent + # Select only advertisers which use another advertiser's floodlight + # configuration. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "advertiser*2015" will return objects with names like "advertiser + # June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the + # searches also add wildcards implicitly at the start and the end of the search + # string. For example, a search string of "advertiser" will match objects with + # name "my advertiser", "advertiser 2015", or simply "advertiser". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] status + # Select only advertisers with the specified status. + # @param [Fixnum] subaccount_id + # Select only advertisers with these subaccount IDs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::AdvertisersListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::AdvertisersListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertisers(profile_id, advertiser_group_ids: nil, floodlight_configuration_ids: nil, ids: nil, include_advertisers_without_groups_only: nil, max_results: nil, only_parent: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, status: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/advertisers', options) + command.response_representation = Google::Apis::DfareportingV3_0::AdvertisersListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::AdvertisersListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserGroupIds'] = advertiser_group_ids unless advertiser_group_ids.nil? + command.query['floodlightConfigurationIds'] = floodlight_configuration_ids unless floodlight_configuration_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['includeAdvertisersWithoutGroupsOnly'] = include_advertisers_without_groups_only unless include_advertisers_without_groups_only.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['onlyParent'] = only_parent unless only_parent.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['status'] = status unless status.nil? + command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing advertiser. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Advertiser ID. + # @param [Google::Apis::DfareportingV3_0::Advertiser] advertiser_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Advertiser] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_advertiser(profile_id, id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/advertisers', options) + command.request_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation + command.request_object = advertiser_object + command.response_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation + command.response_class = Google::Apis::DfareportingV3_0::Advertiser + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing advertiser. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Advertiser] advertiser_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Advertiser] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Advertiser] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_advertiser(profile_id, advertiser_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/advertisers', options) + command.request_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation + command.request_object = advertiser_object + command.response_representation = Google::Apis::DfareportingV3_0::Advertiser::Representation + command.response_class = Google::Apis::DfareportingV3_0::Advertiser + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of browsers. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::BrowsersListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::BrowsersListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_browsers(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/browsers', options) + command.response_representation = Google::Apis::DfareportingV3_0::BrowsersListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::BrowsersListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Associates a creative with the specified campaign. This method creates a + # default ad with dimensions matching the creative in the campaign if such a + # default ad does not exist already. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] campaign_id + # Campaign ID in this association. + # @param [Google::Apis::DfareportingV3_0::CampaignCreativeAssociation] campaign_creative_association_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CampaignCreativeAssociation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CampaignCreativeAssociation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_campaign_creative_association(profile_id, campaign_id, campaign_creative_association_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations', options) + command.request_representation = Google::Apis::DfareportingV3_0::CampaignCreativeAssociation::Representation + command.request_object = campaign_creative_association_object + command.response_representation = Google::Apis::DfareportingV3_0::CampaignCreativeAssociation::Representation + command.response_class = Google::Apis::DfareportingV3_0::CampaignCreativeAssociation + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['campaignId'] = campaign_id unless campaign_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the list of creative IDs associated with the specified campaign. + # This method supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] campaign_id + # Campaign ID in this association. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CampaignCreativeAssociationsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CampaignCreativeAssociationsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_campaign_creative_associations(profile_id, campaign_id, max_results: nil, page_token: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations', options) + command.response_representation = Google::Apis::DfareportingV3_0::CampaignCreativeAssociationsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::CampaignCreativeAssociationsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['campaignId'] = campaign_id unless campaign_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one campaign by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Campaign ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Campaign] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_campaign(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::Campaign::Representation + command.response_class = Google::Apis::DfareportingV3_0::Campaign + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new campaign. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Campaign] campaign_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Campaign] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_campaign(profile_id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/campaigns', options) + command.request_representation = Google::Apis::DfareportingV3_0::Campaign::Representation + command.request_object = campaign_object + command.response_representation = Google::Apis::DfareportingV3_0::Campaign::Representation + command.response_class = Google::Apis::DfareportingV3_0::Campaign + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of campaigns, possibly filtered. This method supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] advertiser_group_ids + # Select only campaigns whose advertisers belong to these advertiser groups. + # @param [Array, Fixnum] advertiser_ids + # Select only campaigns that belong to these advertisers. + # @param [Boolean] archived + # Select only archived campaigns. Don't set this field to select both archived + # and non-archived campaigns. + # @param [Boolean] at_least_one_optimization_activity + # Select only campaigns that have at least one optimization activity. + # @param [Array, Fixnum] excluded_ids + # Exclude campaigns with these IDs. + # @param [Array, Fixnum] ids + # Select only campaigns with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [Fixnum] overridden_event_tag_id + # Select only campaigns that have overridden this event tag ID. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For + # example, "campaign*2015" will return campaigns with names like "campaign June + # 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches + # also add wildcards implicitly at the start and the end of the search string. + # For example, a search string of "campaign" will match campaigns with name "my + # campaign", "campaign 2015", or simply "campaign". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [Fixnum] subaccount_id + # Select only campaigns that belong to this subaccount. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CampaignsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CampaignsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_campaigns(profile_id, advertiser_group_ids: nil, advertiser_ids: nil, archived: nil, at_least_one_optimization_activity: nil, excluded_ids: nil, ids: nil, max_results: nil, overridden_event_tag_id: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns', options) + command.response_representation = Google::Apis::DfareportingV3_0::CampaignsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::CampaignsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserGroupIds'] = advertiser_group_ids unless advertiser_group_ids.nil? + command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? + command.query['archived'] = archived unless archived.nil? + command.query['atLeastOneOptimizationActivity'] = at_least_one_optimization_activity unless at_least_one_optimization_activity.nil? + command.query['excludedIds'] = excluded_ids unless excluded_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['overriddenEventTagId'] = overridden_event_tag_id unless overridden_event_tag_id.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing campaign. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Campaign ID. + # @param [Google::Apis::DfareportingV3_0::Campaign] campaign_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Campaign] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_campaign(profile_id, id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/campaigns', options) + command.request_representation = Google::Apis::DfareportingV3_0::Campaign::Representation + command.request_object = campaign_object + command.response_representation = Google::Apis::DfareportingV3_0::Campaign::Representation + command.response_class = Google::Apis::DfareportingV3_0::Campaign + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing campaign. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Campaign] campaign_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Campaign] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Campaign] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_campaign(profile_id, campaign_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/campaigns', options) + command.request_representation = Google::Apis::DfareportingV3_0::Campaign::Representation + command.request_object = campaign_object + command.response_representation = Google::Apis::DfareportingV3_0::Campaign::Representation + command.response_class = Google::Apis::DfareportingV3_0::Campaign + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one change log by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Change log ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::ChangeLog] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::ChangeLog] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_change_log(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/changeLogs/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::ChangeLog::Representation + command.response_class = Google::Apis::DfareportingV3_0::ChangeLog + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of change logs. This method supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] action + # Select only change logs with the specified action. + # @param [Array, Fixnum] ids + # Select only change logs with these IDs. + # @param [String] max_change_time + # Select only change logs whose change time is before the specified + # maxChangeTime.The time should be formatted as an RFC3339 date/time string. For + # example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, + # the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, + # day, the letter T, the hour (24-hour clock system), minute, second, and then + # the time zone offset. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] min_change_time + # Select only change logs whose change time is before the specified + # minChangeTime.The time should be formatted as an RFC3339 date/time string. For + # example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, + # the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, + # day, the letter T, the hour (24-hour clock system), minute, second, and then + # the time zone offset. + # @param [Array, Fixnum] object_ids + # Select only change logs with these object IDs. + # @param [String] object_type + # Select only change logs with the specified object type. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Select only change logs whose object ID, user name, old or new values match + # the search string. + # @param [Array, Fixnum] user_profile_ids + # Select only change logs with these user profile IDs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::ChangeLogsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::ChangeLogsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_change_logs(profile_id, action: nil, ids: nil, max_change_time: nil, max_results: nil, min_change_time: nil, object_ids: nil, object_type: nil, page_token: nil, search_string: nil, user_profile_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/changeLogs', options) + command.response_representation = Google::Apis::DfareportingV3_0::ChangeLogsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::ChangeLogsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['action'] = action unless action.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxChangeTime'] = max_change_time unless max_change_time.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['minChangeTime'] = min_change_time unless min_change_time.nil? + command.query['objectIds'] = object_ids unless object_ids.nil? + command.query['objectType'] = object_type unless object_type.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['userProfileIds'] = user_profile_ids unless user_profile_ids.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of cities, possibly filtered. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] country_dart_ids + # Select only cities from these countries. + # @param [Array, Fixnum] dart_ids + # Select only cities with these DART IDs. + # @param [String] name_prefix + # Select only cities with names starting with this prefix. + # @param [Array, Fixnum] region_dart_ids + # Select only cities from these regions. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CitiesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CitiesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_cities(profile_id, country_dart_ids: nil, dart_ids: nil, name_prefix: nil, region_dart_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/cities', options) + command.response_representation = Google::Apis::DfareportingV3_0::CitiesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::CitiesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['countryDartIds'] = country_dart_ids unless country_dart_ids.nil? + command.query['dartIds'] = dart_ids unless dart_ids.nil? + command.query['namePrefix'] = name_prefix unless name_prefix.nil? + command.query['regionDartIds'] = region_dart_ids unless region_dart_ids.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one connection type by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Connection type ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::ConnectionType] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::ConnectionType] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_connection_type(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/connectionTypes/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::ConnectionType::Representation + command.response_class = Google::Apis::DfareportingV3_0::ConnectionType + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of connection types. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::ConnectionTypesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::ConnectionTypesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_connection_types(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/connectionTypes', options) + command.response_representation = Google::Apis::DfareportingV3_0::ConnectionTypesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::ConnectionTypesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing content category. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Content category ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_content_category(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/contentCategories/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one content category by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Content category ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::ContentCategory] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::ContentCategory] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_content_category(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/contentCategories/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation + command.response_class = Google::Apis::DfareportingV3_0::ContentCategory + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new content category. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::ContentCategory] content_category_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::ContentCategory] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::ContentCategory] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/contentCategories', options) + command.request_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation + command.request_object = content_category_object + command.response_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation + command.response_class = Google::Apis::DfareportingV3_0::ContentCategory + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of content categories, possibly filtered. This method + # supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] ids + # Select only content categories with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "contentcategory*2015" will return objects with names like " + # contentcategory June 2015", "contentcategory April 2015", or simply " + # contentcategory 2015". Most of the searches also add wildcards implicitly at + # the start and the end of the search string. For example, a search string of " + # contentcategory" will match objects with name "my contentcategory", " + # contentcategory 2015", or simply "contentcategory". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::ContentCategoriesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::ContentCategoriesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_content_categories(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/contentCategories', options) + command.response_representation = Google::Apis::DfareportingV3_0::ContentCategoriesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::ContentCategoriesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing content category. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Content category ID. + # @param [Google::Apis::DfareportingV3_0::ContentCategory] content_category_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::ContentCategory] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::ContentCategory] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_content_category(profile_id, id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/contentCategories', options) + command.request_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation + command.request_object = content_category_object + command.response_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation + command.response_class = Google::Apis::DfareportingV3_0::ContentCategory + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing content category. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::ContentCategory] content_category_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::ContentCategory] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::ContentCategory] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_content_category(profile_id, content_category_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/contentCategories', options) + command.request_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation + command.request_object = content_category_object + command.response_representation = Google::Apis::DfareportingV3_0::ContentCategory::Representation + command.response_class = Google::Apis::DfareportingV3_0::ContentCategory + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts conversions. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::ConversionsBatchInsertRequest] conversions_batch_insert_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::ConversionsBatchInsertResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::ConversionsBatchInsertResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def batchinsert_conversion(profile_id, conversions_batch_insert_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/conversions/batchinsert', options) + command.request_representation = Google::Apis::DfareportingV3_0::ConversionsBatchInsertRequest::Representation + command.request_object = conversions_batch_insert_request_object + command.response_representation = Google::Apis::DfareportingV3_0::ConversionsBatchInsertResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::ConversionsBatchInsertResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates existing conversions. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::ConversionsBatchUpdateRequest] conversions_batch_update_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::ConversionsBatchUpdateResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::ConversionsBatchUpdateResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def batchupdate_conversion(profile_id, conversions_batch_update_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/conversions/batchupdate', options) + command.request_representation = Google::Apis::DfareportingV3_0::ConversionsBatchUpdateRequest::Representation + command.request_object = conversions_batch_update_request_object + command.response_representation = Google::Apis::DfareportingV3_0::ConversionsBatchUpdateResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::ConversionsBatchUpdateResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one country by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] dart_id + # Country DART ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Country] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Country] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_country(profile_id, dart_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/countries/{dartId}', options) + command.response_representation = Google::Apis::DfareportingV3_0::Country::Representation + command.response_class = Google::Apis::DfareportingV3_0::Country + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['dartId'] = dart_id unless dart_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of countries. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CountriesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CountriesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_countries(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/countries', options) + command.response_representation = Google::Apis::DfareportingV3_0::CountriesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::CountriesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new creative asset. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] advertiser_id + # Advertiser ID of this creative. This is a required field. + # @param [Google::Apis::DfareportingV3_0::CreativeAssetMetadata] creative_asset_metadata_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [IO, String] upload_source + # IO stream or filename containing content to upload + # @param [String] content_type + # Content type of the uploaded content. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeAssetMetadata] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeAssetMetadata] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_creative_asset(profile_id, advertiser_id, creative_asset_metadata_object = nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + if upload_source.nil? + command = make_simple_command(:post, 'userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets', options) + else + command = make_upload_command(:post, 'userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets', options) + command.upload_source = upload_source + command.upload_content_type = content_type + end + command.request_representation = Google::Apis::DfareportingV3_0::CreativeAssetMetadata::Representation + command.request_object = creative_asset_metadata_object + command.response_representation = Google::Apis::DfareportingV3_0::CreativeAssetMetadata::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeAssetMetadata + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing creative field value. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] creative_field_id + # Creative field ID for this creative field value. + # @param [Fixnum] id + # Creative Field Value ID + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one creative field value by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] creative_field_id + # Creative field ID for this creative field value. + # @param [Fixnum] id + # Creative Field Value ID + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeFieldValue] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeFieldValue] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_creative_field_value(profile_id, creative_field_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldValue + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new creative field value. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] creative_field_id + # Creative field ID for this creative field value. + # @param [Google::Apis::DfareportingV3_0::CreativeFieldValue] creative_field_value_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeFieldValue] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeFieldValue] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) + command.request_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation + command.request_object = creative_field_value_object + command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldValue + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of creative field values, possibly filtered. This method + # supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] creative_field_id + # Creative field ID for this creative field value. + # @param [Array, Fixnum] ids + # Select only creative field values with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for creative field values by their values. Wildcards (e.g. *) + # are not allowed. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeFieldValuesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeFieldValuesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_creative_field_values(profile_id, creative_field_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) + command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValuesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldValuesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative field value. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] creative_field_id + # Creative field ID for this creative field value. + # @param [Fixnum] id + # Creative Field Value ID + # @param [Google::Apis::DfareportingV3_0::CreativeFieldValue] creative_field_value_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeFieldValue] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeFieldValue] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_creative_field_value(profile_id, creative_field_id, id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) + command.request_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation + command.request_object = creative_field_value_object + command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldValue + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative field value. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] creative_field_id + # Creative field ID for this creative field value. + # @param [Google::Apis::DfareportingV3_0::CreativeFieldValue] creative_field_value_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeFieldValue] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeFieldValue] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_creative_field_value(profile_id, creative_field_id, creative_field_value_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues', options) + command.request_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation + command.request_object = creative_field_value_object + command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldValue::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldValue + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['creativeFieldId'] = creative_field_id unless creative_field_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing creative field. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Creative Field ID + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_creative_field(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/creativeFields/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one creative field by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Creative Field ID + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeField] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeField] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_creative_field(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeField + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new creative field. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::CreativeField] creative_field_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeField] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeField] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/creativeFields', options) + command.request_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation + command.request_object = creative_field_object + command.response_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeField + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of creative fields, possibly filtered. This method supports + # paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] advertiser_ids + # Select only creative fields that belong to these advertisers. + # @param [Array, Fixnum] ids + # Select only creative fields with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for creative fields by name or ID. Wildcards (*) are allowed. + # For example, "creativefield*2015" will return creative fields with names like " + # creativefield June 2015", "creativefield April 2015", or simply "creativefield + # 2015". Most of the searches also add wild-cards implicitly at the start and + # the end of the search string. For example, a search string of "creativefield" + # will match creative fields with the name "my creativefield", "creativefield + # 2015", or simply "creativefield". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeFieldsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeFieldsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_creative_fields(profile_id, advertiser_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creativeFields', options) + command.response_representation = Google::Apis::DfareportingV3_0::CreativeFieldsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeFieldsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative field. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Creative Field ID + # @param [Google::Apis::DfareportingV3_0::CreativeField] creative_field_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeField] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeField] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_creative_field(profile_id, id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeFields', options) + command.request_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation + command.request_object = creative_field_object + command.response_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeField + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative field. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::CreativeField] creative_field_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeField] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeField] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_creative_field(profile_id, creative_field_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/creativeFields', options) + command.request_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation + command.request_object = creative_field_object + command.response_representation = Google::Apis::DfareportingV3_0::CreativeField::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeField + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one creative group by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Creative group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_creative_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creativeGroups/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new creative group. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::CreativeGroup] creative_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/creativeGroups', options) + command.request_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation + command.request_object = creative_group_object + command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of creative groups, possibly filtered. This method supports + # paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] advertiser_ids + # Select only creative groups that belong to these advertisers. + # @param [Fixnum] group_number + # Select only creative groups that belong to this subgroup. + # @param [Array, Fixnum] ids + # Select only creative groups with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for creative groups by name or ID. Wildcards (*) are allowed. + # For example, "creativegroup*2015" will return creative groups with names like " + # creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup + # 2015". Most of the searches also add wild-cards implicitly at the start and + # the end of the search string. For example, a search string of "creativegroup" + # will match creative groups with the name "my creativegroup", "creativegroup + # 2015", or simply "creativegroup". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeGroupsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_creative_groups(profile_id, advertiser_ids: nil, group_number: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creativeGroups', options) + command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeGroupsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? + command.query['groupNumber'] = group_number unless group_number.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative group. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Creative group ID. + # @param [Google::Apis::DfareportingV3_0::CreativeGroup] creative_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_creative_group(profile_id, id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/creativeGroups', options) + command.request_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation + command.request_object = creative_group_object + command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative group. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::CreativeGroup] creative_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativeGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativeGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_creative_group(profile_id, creative_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/creativeGroups', options) + command.request_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation + command.request_object = creative_group_object + command.response_representation = Google::Apis::DfareportingV3_0::CreativeGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativeGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one creative by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Creative ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Creative] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_creative(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creatives/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::Creative::Representation + command.response_class = Google::Apis::DfareportingV3_0::Creative + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new creative. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Creative] creative_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Creative] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/creatives', options) + command.request_representation = Google::Apis::DfareportingV3_0::Creative::Representation + command.request_object = creative_object + command.response_representation = Google::Apis::DfareportingV3_0::Creative::Representation + command.response_class = Google::Apis::DfareportingV3_0::Creative + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of creatives, possibly filtered. This method supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Boolean] active + # Select only active creatives. Leave blank to select active and inactive + # creatives. + # @param [Fixnum] advertiser_id + # Select only creatives with this advertiser ID. + # @param [Boolean] archived + # Select only archived creatives. Leave blank to select archived and unarchived + # creatives. + # @param [Fixnum] campaign_id + # Select only creatives with this campaign ID. + # @param [Array, Fixnum] companion_creative_ids + # Select only in-stream video creatives with these companion IDs. + # @param [Array, Fixnum] creative_field_ids + # Select only creatives with these creative field IDs. + # @param [Array, Fixnum] ids + # Select only creatives with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [Array, Fixnum] rendering_ids + # Select only creatives with these rendering IDs. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "creative*2015" will return objects with names like "creative June + # 2015", "creative April 2015", or simply "creative 2015". Most of the searches + # also add wildcards implicitly at the start and the end of the search string. + # For example, a search string of "creative" will match objects with name "my + # creative", "creative 2015", or simply "creative". + # @param [Array, Fixnum] size_ids + # Select only creatives with these size IDs. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [Fixnum] studio_creative_id + # Select only creatives corresponding to this Studio creative ID. + # @param [Array, String] types + # Select only creatives with these creative types. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CreativesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CreativesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_creatives(profile_id, active: nil, advertiser_id: nil, archived: nil, campaign_id: nil, companion_creative_ids: nil, creative_field_ids: nil, ids: nil, max_results: nil, page_token: nil, rendering_ids: nil, search_string: nil, size_ids: nil, sort_field: nil, sort_order: nil, studio_creative_id: nil, types: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/creatives', options) + command.response_representation = Google::Apis::DfareportingV3_0::CreativesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::CreativesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['active'] = active unless active.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['archived'] = archived unless archived.nil? + command.query['campaignId'] = campaign_id unless campaign_id.nil? + command.query['companionCreativeIds'] = companion_creative_ids unless companion_creative_ids.nil? + command.query['creativeFieldIds'] = creative_field_ids unless creative_field_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['renderingIds'] = rendering_ids unless rendering_ids.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sizeIds'] = size_ids unless size_ids.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['studioCreativeId'] = studio_creative_id unless studio_creative_id.nil? + command.query['types'] = types unless types.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Creative ID. + # @param [Google::Apis::DfareportingV3_0::Creative] creative_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Creative] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_creative(profile_id, id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/creatives', options) + command.request_representation = Google::Apis::DfareportingV3_0::Creative::Representation + command.request_object = creative_object + command.response_representation = Google::Apis::DfareportingV3_0::Creative::Representation + command.response_class = Google::Apis::DfareportingV3_0::Creative + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing creative. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Creative] creative_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Creative] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Creative] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_creative(profile_id, creative_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/creatives', options) + command.request_representation = Google::Apis::DfareportingV3_0::Creative::Representation + command.request_object = creative_object + command.response_representation = Google::Apis::DfareportingV3_0::Creative::Representation + command.response_class = Google::Apis::DfareportingV3_0::Creative + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves list of report dimension values for a list of filters. + # @param [Fixnum] profile_id + # The DFA user profile ID. + # @param [Google::Apis::DfareportingV3_0::DimensionValueRequest] dimension_value_request_object + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # The value of the nextToken from the previous result page. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::DimensionValueList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::DimensionValueList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def query_dimension_value(profile_id, dimension_value_request_object = nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/dimensionvalues/query', options) + command.request_representation = Google::Apis::DfareportingV3_0::DimensionValueRequest::Representation + command.request_object = dimension_value_request_object + command.response_representation = Google::Apis::DfareportingV3_0::DimensionValueList::Representation + command.response_class = Google::Apis::DfareportingV3_0::DimensionValueList + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one directory site contact by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Directory site contact ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::DirectorySiteContact] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::DirectorySiteContact] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_directory_site_contact(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/directorySiteContacts/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::DirectorySiteContact::Representation + command.response_class = Google::Apis::DfareportingV3_0::DirectorySiteContact + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of directory site contacts, possibly filtered. This method + # supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] directory_site_ids + # Select only directory site contacts with these directory site IDs. This is a + # required field. + # @param [Array, Fixnum] ids + # Select only directory site contacts with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name, ID or email. Wildcards (*) are allowed. + # For example, "directory site contact*2015" will return objects with names like + # "directory site contact June 2015", "directory site contact April 2015", or + # simply "directory site contact 2015". Most of the searches also add wildcards + # implicitly at the start and the end of the search string. For example, a + # search string of "directory site contact" will match objects with name "my + # directory site contact", "directory site contact 2015", or simply "directory + # site contact". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::DirectorySiteContactsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::DirectorySiteContactsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_directory_site_contacts(profile_id, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/directorySiteContacts', options) + command.response_representation = Google::Apis::DfareportingV3_0::DirectorySiteContactsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::DirectorySiteContactsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one directory site by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Directory site ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::DirectorySite] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::DirectorySite] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_directory_site(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/directorySites/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::DirectorySite::Representation + command.response_class = Google::Apis::DfareportingV3_0::DirectorySite + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new directory site. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::DirectorySite] directory_site_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::DirectorySite] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::DirectorySite] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_directory_site(profile_id, directory_site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/directorySites', options) + command.request_representation = Google::Apis::DfareportingV3_0::DirectorySite::Representation + command.request_object = directory_site_object + command.response_representation = Google::Apis::DfareportingV3_0::DirectorySite::Representation + command.response_class = Google::Apis::DfareportingV3_0::DirectorySite + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of directory sites, possibly filtered. This method supports + # paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Boolean] accepts_in_stream_video_placements + # This search filter is no longer supported and will have no effect on the + # results returned. + # @param [Boolean] accepts_interstitial_placements + # This search filter is no longer supported and will have no effect on the + # results returned. + # @param [Boolean] accepts_publisher_paid_placements + # Select only directory sites that accept publisher paid placements. This field + # can be left blank. + # @param [Boolean] active + # Select only active directory sites. Leave blank to retrieve both active and + # inactive directory sites. + # @param [Fixnum] country_id + # Select only directory sites with this country ID. + # @param [String] dfp_network_code + # Select only directory sites with this DFP network code. + # @param [Array, Fixnum] ids + # Select only directory sites with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [Fixnum] parent_id + # Select only directory sites with this parent ID. + # @param [String] search_string + # Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. + # For example, "directory site*2015" will return objects with names like " + # directory site June 2015", "directory site April 2015", or simply "directory + # site 2015". Most of the searches also add wildcards implicitly at the start + # and the end of the search string. For example, a search string of "directory + # site" will match objects with name "my directory site", "directory site 2015" + # or simply, "directory site". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::DirectorySitesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::DirectorySitesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_directory_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, active: nil, country_id: nil, dfp_network_code: nil, ids: nil, max_results: nil, page_token: nil, parent_id: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/directorySites', options) + command.response_representation = Google::Apis::DfareportingV3_0::DirectorySitesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::DirectorySitesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['acceptsInStreamVideoPlacements'] = accepts_in_stream_video_placements unless accepts_in_stream_video_placements.nil? + command.query['acceptsInterstitialPlacements'] = accepts_interstitial_placements unless accepts_interstitial_placements.nil? + command.query['acceptsPublisherPaidPlacements'] = accepts_publisher_paid_placements unless accepts_publisher_paid_placements.nil? + command.query['active'] = active unless active.nil? + command.query['countryId'] = country_id unless country_id.nil? + command.query['dfpNetworkCode'] = dfp_network_code unless dfp_network_code.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['parentId'] = parent_id unless parent_id.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing dynamic targeting key. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] object_id_ + # ID of the object of this dynamic targeting key. This is a required field. + # @param [String] name + # Name of this dynamic targeting key. This is a required field. Must be less + # than 256 characters long and cannot contain commas. All characters are + # converted to lowercase. + # @param [String] object_type + # Type of the object of this dynamic targeting key. This is a required field. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_dynamic_targeting_key(profile_id, object_id_, name, object_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/dynamicTargetingKeys/{objectId}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['objectId'] = object_id_ unless object_id_.nil? + command.query['name'] = name unless name.nil? + command.query['objectType'] = object_type unless object_type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new dynamic targeting key. Keys must be created at the advertiser + # level before being assigned to the advertiser's ads, creatives, or placements. + # There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 + # keys can be assigned per ad, creative, or placement. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::DynamicTargetingKey] dynamic_targeting_key_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::DynamicTargetingKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::DynamicTargetingKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_dynamic_targeting_key(profile_id, dynamic_targeting_key_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/dynamicTargetingKeys', options) + command.request_representation = Google::Apis::DfareportingV3_0::DynamicTargetingKey::Representation + command.request_object = dynamic_targeting_key_object + command.response_representation = Google::Apis::DfareportingV3_0::DynamicTargetingKey::Representation + command.response_class = Google::Apis::DfareportingV3_0::DynamicTargetingKey + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of dynamic targeting keys. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] advertiser_id + # Select only dynamic targeting keys whose object has this advertiser ID. + # @param [Array, String] names + # Select only dynamic targeting keys exactly matching these names. + # @param [Fixnum] object_id_ + # Select only dynamic targeting keys with this object ID. + # @param [String] object_type + # Select only dynamic targeting keys with this object type. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::DynamicTargetingKeysListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::DynamicTargetingKeysListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_dynamic_targeting_keys(profile_id, advertiser_id: nil, names: nil, object_id_: nil, object_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/dynamicTargetingKeys', options) + command.response_representation = Google::Apis::DfareportingV3_0::DynamicTargetingKeysListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::DynamicTargetingKeysListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['names'] = names unless names.nil? + command.query['objectId'] = object_id_ unless object_id_.nil? + command.query['objectType'] = object_type unless object_type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing event tag. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Event tag ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_event_tag(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/eventTags/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one event tag by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Event tag ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::EventTag] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::EventTag] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_event_tag(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/eventTags/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::EventTag::Representation + command.response_class = Google::Apis::DfareportingV3_0::EventTag + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new event tag. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::EventTag] event_tag_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::EventTag] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::EventTag] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/eventTags', options) + command.request_representation = Google::Apis::DfareportingV3_0::EventTag::Representation + command.request_object = event_tag_object + command.response_representation = Google::Apis::DfareportingV3_0::EventTag::Representation + command.response_class = Google::Apis::DfareportingV3_0::EventTag + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of event tags, possibly filtered. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] ad_id + # Select only event tags that belong to this ad. + # @param [Fixnum] advertiser_id + # Select only event tags that belong to this advertiser. + # @param [Fixnum] campaign_id + # Select only event tags that belong to this campaign. + # @param [Boolean] definitions_only + # Examine only the specified campaign or advertiser's event tags for matching + # selector criteria. When set to false, the parent advertiser and parent + # campaign of the specified ad or campaign is examined as well. In addition, + # when set to false, the status field is examined as well, along with the + # enabledByDefault field. This parameter can not be set to true when adId is + # specified as ads do not define their own even tags. + # @param [Boolean] enabled + # Select only enabled event tags. What is considered enabled or disabled depends + # on the definitionsOnly parameter. When definitionsOnly is set to true, only + # the specified advertiser or campaign's event tags' enabledByDefault field is + # examined. When definitionsOnly is set to false, the specified ad or specified + # campaign's parent advertiser's or parent campaign's event tags' + # enabledByDefault and status fields are examined as well. + # @param [Array, String] event_tag_types + # Select only event tags with the specified event tag types. Event tag types can + # be used to specify whether to use a third-party pixel, a third-party + # JavaScript URL, or a third-party click-through URL for either impression or + # click tracking. + # @param [Array, Fixnum] ids + # Select only event tags with these IDs. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "eventtag*2015" will return objects with names like "eventtag June + # 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches + # also add wildcards implicitly at the start and the end of the search string. + # For example, a search string of "eventtag" will match objects with name "my + # eventtag", "eventtag 2015", or simply "eventtag". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::EventTagsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::EventTagsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_event_tags(profile_id, ad_id: nil, advertiser_id: nil, campaign_id: nil, definitions_only: nil, enabled: nil, event_tag_types: nil, ids: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/eventTags', options) + command.response_representation = Google::Apis::DfareportingV3_0::EventTagsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::EventTagsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['adId'] = ad_id unless ad_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['campaignId'] = campaign_id unless campaign_id.nil? + command.query['definitionsOnly'] = definitions_only unless definitions_only.nil? + command.query['enabled'] = enabled unless enabled.nil? + command.query['eventTagTypes'] = event_tag_types unless event_tag_types.nil? + command.query['ids'] = ids unless ids.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing event tag. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Event tag ID. + # @param [Google::Apis::DfareportingV3_0::EventTag] event_tag_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::EventTag] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::EventTag] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_event_tag(profile_id, id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/eventTags', options) + command.request_representation = Google::Apis::DfareportingV3_0::EventTag::Representation + command.request_object = event_tag_object + command.response_representation = Google::Apis::DfareportingV3_0::EventTag::Representation + command.response_class = Google::Apis::DfareportingV3_0::EventTag + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing event tag. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::EventTag] event_tag_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::EventTag] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::EventTag] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_event_tag(profile_id, event_tag_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/eventTags', options) + command.request_representation = Google::Apis::DfareportingV3_0::EventTag::Representation + command.request_object = event_tag_object + command.response_representation = Google::Apis::DfareportingV3_0::EventTag::Representation + command.response_class = Google::Apis::DfareportingV3_0::EventTag + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a report file by its report ID and file ID. This method supports + # media download. + # @param [Fixnum] report_id + # The ID of the report. + # @param [Fixnum] file_id + # The ID of the report file. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [IO, String] download_dest + # IO stream or filename to receive content download + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::File] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::File] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_file(report_id, file_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) + if download_dest.nil? + command = make_simple_command(:get, 'reports/{reportId}/files/{fileId}', options) + else + command = make_download_command(:get, 'reports/{reportId}/files/{fileId}', options) + command.download_dest = download_dest + end + command.response_representation = Google::Apis::DfareportingV3_0::File::Representation + command.response_class = Google::Apis::DfareportingV3_0::File + command.params['reportId'] = report_id unless report_id.nil? + command.params['fileId'] = file_id unless file_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists files for a user profile. + # @param [Fixnum] profile_id + # The DFA profile ID. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # The value of the nextToken from the previous result page. + # @param [String] scope + # The scope that defines which results are returned. + # @param [String] sort_field + # The field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FileList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FileList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_files(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/files', options) + command.response_representation = Google::Apis::DfareportingV3_0::FileList::Representation + command.response_class = Google::Apis::DfareportingV3_0::FileList + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['scope'] = scope unless scope.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing floodlight activity. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Floodlight activity ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/floodlightActivities/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Generates a tag for a floodlight activity. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] floodlight_activity_id + # Floodlight activity ID for which we want to generate a tag. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivitiesGenerateTagResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightActivitiesGenerateTagResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def generatetag_floodlight_activity(profile_id, floodlight_activity_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivities/generatetag', options) + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivitiesGenerateTagResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivitiesGenerateTagResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one floodlight activity by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Floodlight activity ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivity] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightActivity] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_floodlight_activity(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivities/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivity + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new floodlight activity. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::FloodlightActivity] floodlight_activity_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivity] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightActivity] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivities', options) + command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation + command.request_object = floodlight_activity_object + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivity + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of floodlight activities, possibly filtered. This method + # supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] advertiser_id + # Select only floodlight activities for the specified advertiser ID. Must + # specify either ids, advertiserId, or floodlightConfigurationId for a non-empty + # result. + # @param [Array, Fixnum] floodlight_activity_group_ids + # Select only floodlight activities with the specified floodlight activity group + # IDs. + # @param [String] floodlight_activity_group_name + # Select only floodlight activities with the specified floodlight activity group + # name. + # @param [String] floodlight_activity_group_tag_string + # Select only floodlight activities with the specified floodlight activity group + # tag string. + # @param [String] floodlight_activity_group_type + # Select only floodlight activities with the specified floodlight activity group + # type. + # @param [Fixnum] floodlight_configuration_id + # Select only floodlight activities for the specified floodlight configuration + # ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a + # non-empty result. + # @param [Array, Fixnum] ids + # Select only floodlight activities with the specified IDs. Must specify either + # ids, advertiserId, or floodlightConfigurationId for a non-empty result. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "floodlightactivity*2015" will return objects with names like " + # floodlightactivity June 2015", "floodlightactivity April 2015", or simply " + # floodlightactivity 2015". Most of the searches also add wildcards implicitly + # at the start and the end of the search string. For example, a search string of + # "floodlightactivity" will match objects with name "my floodlightactivity + # activity", "floodlightactivity 2015", or simply "floodlightactivity". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] tag_string + # Select only floodlight activities with the specified tag string. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivitiesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightActivitiesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_floodlight_activities(profile_id, advertiser_id: nil, floodlight_activity_group_ids: nil, floodlight_activity_group_name: nil, floodlight_activity_group_tag_string: nil, floodlight_activity_group_type: nil, floodlight_configuration_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, tag_string: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivities', options) + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivitiesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivitiesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['floodlightActivityGroupIds'] = floodlight_activity_group_ids unless floodlight_activity_group_ids.nil? + command.query['floodlightActivityGroupName'] = floodlight_activity_group_name unless floodlight_activity_group_name.nil? + command.query['floodlightActivityGroupTagString'] = floodlight_activity_group_tag_string unless floodlight_activity_group_tag_string.nil? + command.query['floodlightActivityGroupType'] = floodlight_activity_group_type unless floodlight_activity_group_type.nil? + command.query['floodlightConfigurationId'] = floodlight_configuration_id unless floodlight_configuration_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['tagString'] = tag_string unless tag_string.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing floodlight activity. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Floodlight activity ID. + # @param [Google::Apis::DfareportingV3_0::FloodlightActivity] floodlight_activity_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivity] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightActivity] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_floodlight_activity(profile_id, id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightActivities', options) + command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation + command.request_object = floodlight_activity_object + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivity + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing floodlight activity. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::FloodlightActivity] floodlight_activity_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivity] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightActivity] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_floodlight_activity(profile_id, floodlight_activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightActivities', options) + command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation + command.request_object = floodlight_activity_object + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivity::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivity + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one floodlight activity group by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Floodlight activity Group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_floodlight_activity_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivityGroups/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivityGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new floodlight activity group. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] floodlight_activity_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/floodlightActivityGroups', options) + command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation + command.request_object = floodlight_activity_group_object + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivityGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of floodlight activity groups, possibly filtered. This method + # supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] advertiser_id + # Select only floodlight activity groups with the specified advertiser ID. Must + # specify either advertiserId or floodlightConfigurationId for a non-empty + # result. + # @param [Fixnum] floodlight_configuration_id + # Select only floodlight activity groups with the specified floodlight + # configuration ID. Must specify either advertiserId, or + # floodlightConfigurationId for a non-empty result. + # @param [Array, Fixnum] ids + # Select only floodlight activity groups with the specified IDs. Must specify + # either advertiserId or floodlightConfigurationId for a non-empty result. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "floodlightactivitygroup*2015" will return objects with names like " + # floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or + # simply "floodlightactivitygroup 2015". Most of the searches also add wildcards + # implicitly at the start and the end of the search string. For example, a + # search string of "floodlightactivitygroup" will match objects with name "my + # floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply " + # floodlightactivitygroup". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] type + # Select only floodlight activity groups with the specified floodlight activity + # group type. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivityGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightActivityGroupsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_floodlight_activity_groups(profile_id, advertiser_id: nil, floodlight_configuration_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightActivityGroups', options) + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivityGroupsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['floodlightConfigurationId'] = floodlight_configuration_id unless floodlight_configuration_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing floodlight activity group. This method supports patch + # semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Floodlight activity Group ID. + # @param [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] floodlight_activity_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_floodlight_activity_group(profile_id, id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightActivityGroups', options) + command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation + command.request_object = floodlight_activity_group_object + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivityGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing floodlight activity group. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] floodlight_activity_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightActivityGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_floodlight_activity_group(profile_id, floodlight_activity_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightActivityGroups', options) + command.request_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation + command.request_object = floodlight_activity_group_object + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightActivityGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightActivityGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one floodlight configuration by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Floodlight configuration ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightConfiguration] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightConfiguration] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_floodlight_configuration(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightConfigurations/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightConfiguration + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of floodlight configurations, possibly filtered. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] ids + # Set of IDs of floodlight configurations to retrieve. Required field; otherwise + # an empty list will be returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightConfigurationsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightConfigurationsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_floodlight_configurations(profile_id, ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/floodlightConfigurations', options) + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightConfigurationsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightConfigurationsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing floodlight configuration. This method supports patch + # semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Floodlight configuration ID. + # @param [Google::Apis::DfareportingV3_0::FloodlightConfiguration] floodlight_configuration_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightConfiguration] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightConfiguration] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_floodlight_configuration(profile_id, id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/floodlightConfigurations', options) + command.request_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation + command.request_object = floodlight_configuration_object + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightConfiguration + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing floodlight configuration. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::FloodlightConfiguration] floodlight_configuration_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FloodlightConfiguration] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FloodlightConfiguration] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_floodlight_configuration(profile_id, floodlight_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/floodlightConfigurations', options) + command.request_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation + command.request_object = floodlight_configuration_object + command.response_representation = Google::Apis::DfareportingV3_0::FloodlightConfiguration::Representation + command.response_class = Google::Apis::DfareportingV3_0::FloodlightConfiguration + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one inventory item by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] project_id + # Project ID for order documents. + # @param [Fixnum] id + # Inventory item ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::InventoryItem] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::InventoryItem] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_inventory_item(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::InventoryItem::Representation + command.response_class = Google::Apis::DfareportingV3_0::InventoryItem + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['projectId'] = project_id unless project_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of inventory items, possibly filtered. This method supports + # paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] project_id + # Project ID for order documents. + # @param [Array, Fixnum] ids + # Select only inventory items with these IDs. + # @param [Boolean] in_plan + # Select only inventory items that are in plan. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [Array, Fixnum] order_id + # Select only inventory items that belong to specified orders. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [Array, Fixnum] site_id + # Select only inventory items that are associated with these sites. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] type + # Select only inventory items with this type. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::InventoryItemsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::InventoryItemsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_inventory_items(profile_id, project_id, ids: nil, in_plan: nil, max_results: nil, order_id: nil, page_token: nil, site_id: nil, sort_field: nil, sort_order: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/inventoryItems', options) + command.response_representation = Google::Apis::DfareportingV3_0::InventoryItemsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::InventoryItemsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['projectId'] = project_id unless project_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['inPlan'] = in_plan unless in_plan.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderId'] = order_id unless order_id.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['siteId'] = site_id unless site_id.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of languages. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::LanguagesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::LanguagesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_languages(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/languages', options) + command.response_representation = Google::Apis::DfareportingV3_0::LanguagesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::LanguagesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of metros. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::MetrosListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::MetrosListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_metros(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/metros', options) + command.response_representation = Google::Apis::DfareportingV3_0::MetrosListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::MetrosListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one mobile carrier by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Mobile carrier ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::MobileCarrier] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::MobileCarrier] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_mobile_carrier(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/mobileCarriers/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::MobileCarrier::Representation + command.response_class = Google::Apis::DfareportingV3_0::MobileCarrier + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of mobile carriers. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::MobileCarriersListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::MobileCarriersListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_mobile_carriers(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/mobileCarriers', options) + command.response_representation = Google::Apis::DfareportingV3_0::MobileCarriersListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::MobileCarriersListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one operating system version by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Operating system version ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::OperatingSystemVersion] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::OperatingSystemVersion] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_operating_system_version(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystemVersions/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::OperatingSystemVersion::Representation + command.response_class = Google::Apis::DfareportingV3_0::OperatingSystemVersion + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of operating system versions. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::OperatingSystemVersionsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::OperatingSystemVersionsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_operating_system_versions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystemVersions', options) + command.response_representation = Google::Apis::DfareportingV3_0::OperatingSystemVersionsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::OperatingSystemVersionsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one operating system by DART ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] dart_id + # Operating system DART ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::OperatingSystem] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::OperatingSystem] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_operating_system(profile_id, dart_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystems/{dartId}', options) + command.response_representation = Google::Apis::DfareportingV3_0::OperatingSystem::Representation + command.response_class = Google::Apis::DfareportingV3_0::OperatingSystem + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['dartId'] = dart_id unless dart_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of operating systems. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::OperatingSystemsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::OperatingSystemsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_operating_systems(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/operatingSystems', options) + command.response_representation = Google::Apis::DfareportingV3_0::OperatingSystemsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::OperatingSystemsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one order document by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] project_id + # Project ID for order documents. + # @param [Fixnum] id + # Order document ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::OrderDocument] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::OrderDocument] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_order_document(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::OrderDocument::Representation + command.response_class = Google::Apis::DfareportingV3_0::OrderDocument + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['projectId'] = project_id unless project_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of order documents, possibly filtered. This method supports + # paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] project_id + # Project ID for order documents. + # @param [Boolean] approved + # Select only order documents that have been approved by at least one user. + # @param [Array, Fixnum] ids + # Select only order documents with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [Array, Fixnum] order_id + # Select only order documents for specified orders. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for order documents by name or ID. Wildcards (*) are allowed. + # For example, "orderdocument*2015" will return order documents with names like " + # orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument + # 2015". Most of the searches also add wildcards implicitly at the start and the + # end of the search string. For example, a search string of "orderdocument" will + # match order documents with name "my orderdocument", "orderdocument 2015", or + # simply "orderdocument". + # @param [Array, Fixnum] site_id + # Select only order documents that are associated with these sites. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::OrderDocumentsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::OrderDocumentsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_order_documents(profile_id, project_id, approved: nil, ids: nil, max_results: nil, order_id: nil, page_token: nil, search_string: nil, site_id: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orderDocuments', options) + command.response_representation = Google::Apis::DfareportingV3_0::OrderDocumentsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::OrderDocumentsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['projectId'] = project_id unless project_id.nil? + command.query['approved'] = approved unless approved.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['orderId'] = order_id unless order_id.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['siteId'] = site_id unless site_id.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one order by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] project_id + # Project ID for orders. + # @param [Fixnum] id + # Order ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Order] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Order] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_order(profile_id, project_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orders/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::Order::Representation + command.response_class = Google::Apis::DfareportingV3_0::Order + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['projectId'] = project_id unless project_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of orders, possibly filtered. This method supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] project_id + # Project ID for orders. + # @param [Array, Fixnum] ids + # Select only orders with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for orders by name or ID. Wildcards (*) are allowed. For + # example, "order*2015" will return orders with names like "order June 2015", " + # order April 2015", or simply "order 2015". Most of the searches also add + # wildcards implicitly at the start and the end of the search string. For + # example, a search string of "order" will match orders with name "my order", " + # order 2015", or simply "order". + # @param [Array, Fixnum] site_id + # Select only orders that are associated with these site IDs. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::OrdersListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::OrdersListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_orders(profile_id, project_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, site_id: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{projectId}/orders', options) + command.response_representation = Google::Apis::DfareportingV3_0::OrdersListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::OrdersListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['projectId'] = project_id unless project_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['siteId'] = site_id unless site_id.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one placement group by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Placement group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PlacementGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_placement_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/placementGroups/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::PlacementGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new placement group. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::PlacementGroup] placement_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PlacementGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/placementGroups', options) + command.request_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation + command.request_object = placement_group_object + command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::PlacementGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of placement groups, possibly filtered. This method supports + # paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] advertiser_ids + # Select only placement groups that belong to these advertisers. + # @param [Boolean] archived + # Select only archived placements. Don't set this field to select both archived + # and non-archived placements. + # @param [Array, Fixnum] campaign_ids + # Select only placement groups that belong to these campaigns. + # @param [Array, Fixnum] content_category_ids + # Select only placement groups that are associated with these content categories. + # @param [Array, Fixnum] directory_site_ids + # Select only placement groups that are associated with these directory sites. + # @param [Array, Fixnum] ids + # Select only placement groups with these IDs. + # @param [String] max_end_date + # Select only placements or placement groups whose end date is on or before the + # specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] max_start_date + # Select only placements or placement groups whose start date is on or before + # the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". + # @param [String] min_end_date + # Select only placements or placement groups whose end date is on or after the + # specified minEndDate. The date should be formatted as "yyyy-MM-dd". + # @param [String] min_start_date + # Select only placements or placement groups whose start date is on or after the + # specified minStartDate. The date should be formatted as "yyyy-MM-dd". + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] placement_group_type + # Select only placement groups belonging with this group type. A package is a + # simple group of placements that acts as a single pricing point for a group of + # tags. A roadblock is a group of placements that not only acts as a single + # pricing point but also assumes that all the tags in it will be served at the + # same time. A roadblock requires one of its assigned placements to be marked as + # primary for reporting. + # @param [Array, Fixnum] placement_strategy_ids + # Select only placement groups that are associated with these placement + # strategies. + # @param [Array, String] pricing_types + # Select only placement groups with these pricing types. + # @param [String] search_string + # Allows searching for placement groups by name or ID. Wildcards (*) are allowed. + # For example, "placement*2015" will return placement groups with names like " + # placement group June 2015", "placement group May 2015", or simply "placements + # 2015". Most of the searches also add wildcards implicitly at the start and the + # end of the search string. For example, a search string of "placementgroup" + # will match placement groups with name "my placementgroup", "placementgroup + # 2015", or simply "placementgroup". + # @param [Array, Fixnum] site_ids + # Select only placement groups that are associated with these sites. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PlacementGroupsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_placement_groups(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, content_category_ids: nil, directory_site_ids: nil, ids: nil, max_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: nil, page_token: nil, placement_group_type: nil, placement_strategy_ids: nil, pricing_types: nil, search_string: nil, site_ids: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/placementGroups', options) + command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::PlacementGroupsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? + command.query['archived'] = archived unless archived.nil? + command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? + command.query['contentCategoryIds'] = content_category_ids unless content_category_ids.nil? + command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxEndDate'] = max_end_date unless max_end_date.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['maxStartDate'] = max_start_date unless max_start_date.nil? + command.query['minEndDate'] = min_end_date unless min_end_date.nil? + command.query['minStartDate'] = min_start_date unless min_start_date.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['placementGroupType'] = placement_group_type unless placement_group_type.nil? + command.query['placementStrategyIds'] = placement_strategy_ids unless placement_strategy_ids.nil? + command.query['pricingTypes'] = pricing_types unless pricing_types.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['siteIds'] = site_ids unless site_ids.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing placement group. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Placement group ID. + # @param [Google::Apis::DfareportingV3_0::PlacementGroup] placement_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PlacementGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_placement_group(profile_id, id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/placementGroups', options) + command.request_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation + command.request_object = placement_group_object + command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::PlacementGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing placement group. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::PlacementGroup] placement_group_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PlacementGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_placement_group(profile_id, placement_group_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/placementGroups', options) + command.request_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation + command.request_object = placement_group_object + command.response_representation = Google::Apis::DfareportingV3_0::PlacementGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::PlacementGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing placement strategy. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Placement strategy ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_placement_strategy(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/placementStrategies/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one placement strategy by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Placement strategy ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementStrategy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PlacementStrategy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_placement_strategy(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/placementStrategies/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation + command.response_class = Google::Apis::DfareportingV3_0::PlacementStrategy + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new placement strategy. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::PlacementStrategy] placement_strategy_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementStrategy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PlacementStrategy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/placementStrategies', options) + command.request_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation + command.request_object = placement_strategy_object + command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation + command.response_class = Google::Apis::DfareportingV3_0::PlacementStrategy + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of placement strategies, possibly filtered. This method + # supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] ids + # Select only placement strategies with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "placementstrategy*2015" will return objects with names like " + # placementstrategy June 2015", "placementstrategy April 2015", or simply " + # placementstrategy 2015". Most of the searches also add wildcards implicitly at + # the start and the end of the search string. For example, a search string of " + # placementstrategy" will match objects with name "my placementstrategy", " + # placementstrategy 2015", or simply "placementstrategy". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementStrategiesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PlacementStrategiesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_placement_strategies(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/placementStrategies', options) + command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategiesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::PlacementStrategiesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing placement strategy. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Placement strategy ID. + # @param [Google::Apis::DfareportingV3_0::PlacementStrategy] placement_strategy_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementStrategy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PlacementStrategy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_placement_strategy(profile_id, id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/placementStrategies', options) + command.request_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation + command.request_object = placement_strategy_object + command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation + command.response_class = Google::Apis::DfareportingV3_0::PlacementStrategy + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing placement strategy. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::PlacementStrategy] placement_strategy_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementStrategy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PlacementStrategy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_placement_strategy(profile_id, placement_strategy_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/placementStrategies', options) + command.request_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation + command.request_object = placement_strategy_object + command.response_representation = Google::Apis::DfareportingV3_0::PlacementStrategy::Representation + command.response_class = Google::Apis::DfareportingV3_0::PlacementStrategy + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Generates tags for a placement. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] campaign_id + # Generate placements belonging to this campaign. This is a required field. + # @param [Array, Fixnum] placement_ids + # Generate tags for these placements. + # @param [Array, String] tag_formats + # Tag formats to generate for these placements. + # Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementsGenerateTagsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PlacementsGenerateTagsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def generatetags_placement(profile_id, campaign_id: nil, placement_ids: nil, tag_formats: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/placements/generatetags', options) + command.response_representation = Google::Apis::DfareportingV3_0::PlacementsGenerateTagsResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::PlacementsGenerateTagsResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['campaignId'] = campaign_id unless campaign_id.nil? + command.query['placementIds'] = placement_ids unless placement_ids.nil? + command.query['tagFormats'] = tag_formats unless tag_formats.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one placement by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Placement ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Placement] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Placement] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_placement(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/placements/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::Placement::Representation + command.response_class = Google::Apis::DfareportingV3_0::Placement + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new placement. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Placement] placement_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Placement] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Placement] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/placements', options) + command.request_representation = Google::Apis::DfareportingV3_0::Placement::Representation + command.request_object = placement_object + command.response_representation = Google::Apis::DfareportingV3_0::Placement::Representation + command.response_class = Google::Apis::DfareportingV3_0::Placement + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of placements, possibly filtered. This method supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] advertiser_ids + # Select only placements that belong to these advertisers. + # @param [Boolean] archived + # Select only archived placements. Don't set this field to select both archived + # and non-archived placements. + # @param [Array, Fixnum] campaign_ids + # Select only placements that belong to these campaigns. + # @param [Array, String] compatibilities + # Select only placements that are associated with these compatibilities. DISPLAY + # and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile + # devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL + # are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in- + # stream video ads developed with the VAST standard. + # @param [Array, Fixnum] content_category_ids + # Select only placements that are associated with these content categories. + # @param [Array, Fixnum] directory_site_ids + # Select only placements that are associated with these directory sites. + # @param [Array, Fixnum] group_ids + # Select only placements that belong to these placement groups. + # @param [Array, Fixnum] ids + # Select only placements with these IDs. + # @param [String] max_end_date + # Select only placements or placement groups whose end date is on or before the + # specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] max_start_date + # Select only placements or placement groups whose start date is on or before + # the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". + # @param [String] min_end_date + # Select only placements or placement groups whose end date is on or after the + # specified minEndDate. The date should be formatted as "yyyy-MM-dd". + # @param [String] min_start_date + # Select only placements or placement groups whose start date is on or after the + # specified minStartDate. The date should be formatted as "yyyy-MM-dd". + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] payment_source + # Select only placements with this payment source. + # @param [Array, Fixnum] placement_strategy_ids + # Select only placements that are associated with these placement strategies. + # @param [Array, String] pricing_types + # Select only placements with these pricing types. + # @param [String] search_string + # Allows searching for placements by name or ID. Wildcards (*) are allowed. For + # example, "placement*2015" will return placements with names like "placement + # June 2015", "placement May 2015", or simply "placements 2015". Most of the + # searches also add wildcards implicitly at the start and the end of the search + # string. For example, a search string of "placement" will match placements with + # name "my placement", "placement 2015", or simply "placement". + # @param [Array, Fixnum] site_ids + # Select only placements that are associated with these sites. + # @param [Array, Fixnum] size_ids + # Select only placements that are associated with these sizes. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PlacementsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PlacementsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_placements(profile_id, advertiser_ids: nil, archived: nil, campaign_ids: nil, compatibilities: nil, content_category_ids: nil, directory_site_ids: nil, group_ids: nil, ids: nil, max_end_date: nil, max_results: nil, max_start_date: nil, min_end_date: nil, min_start_date: nil, page_token: nil, payment_source: nil, placement_strategy_ids: nil, pricing_types: nil, search_string: nil, site_ids: nil, size_ids: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/placements', options) + command.response_representation = Google::Apis::DfareportingV3_0::PlacementsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::PlacementsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? + command.query['archived'] = archived unless archived.nil? + command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? + command.query['compatibilities'] = compatibilities unless compatibilities.nil? + command.query['contentCategoryIds'] = content_category_ids unless content_category_ids.nil? + command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? + command.query['groupIds'] = group_ids unless group_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxEndDate'] = max_end_date unless max_end_date.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['maxStartDate'] = max_start_date unless max_start_date.nil? + command.query['minEndDate'] = min_end_date unless min_end_date.nil? + command.query['minStartDate'] = min_start_date unless min_start_date.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['paymentSource'] = payment_source unless payment_source.nil? + command.query['placementStrategyIds'] = placement_strategy_ids unless placement_strategy_ids.nil? + command.query['pricingTypes'] = pricing_types unless pricing_types.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['siteIds'] = site_ids unless site_ids.nil? + command.query['sizeIds'] = size_ids unless size_ids.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing placement. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Placement ID. + # @param [Google::Apis::DfareportingV3_0::Placement] placement_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Placement] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Placement] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_placement(profile_id, id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/placements', options) + command.request_representation = Google::Apis::DfareportingV3_0::Placement::Representation + command.request_object = placement_object + command.response_representation = Google::Apis::DfareportingV3_0::Placement::Representation + command.response_class = Google::Apis::DfareportingV3_0::Placement + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing placement. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Placement] placement_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Placement] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Placement] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_placement(profile_id, placement_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/placements', options) + command.request_representation = Google::Apis::DfareportingV3_0::Placement::Representation + command.request_object = placement_object + command.response_representation = Google::Apis::DfareportingV3_0::Placement::Representation + command.response_class = Google::Apis::DfareportingV3_0::Placement + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one platform type by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Platform type ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PlatformType] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PlatformType] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_platform_type(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/platformTypes/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::PlatformType::Representation + command.response_class = Google::Apis::DfareportingV3_0::PlatformType + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of platform types. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PlatformTypesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PlatformTypesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_platform_types(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/platformTypes', options) + command.response_representation = Google::Apis::DfareportingV3_0::PlatformTypesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::PlatformTypesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one postal code by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] code + # Postal code ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PostalCode] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PostalCode] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_postal_code(profile_id, code, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/postalCodes/{code}', options) + command.response_representation = Google::Apis::DfareportingV3_0::PostalCode::Representation + command.response_class = Google::Apis::DfareportingV3_0::PostalCode + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['code'] = code unless code.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of postal codes. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::PostalCodesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::PostalCodesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_postal_codes(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/postalCodes', options) + command.response_representation = Google::Apis::DfareportingV3_0::PostalCodesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::PostalCodesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one project by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Project ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Project] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Project] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::Project::Representation + command.response_class = Google::Apis::DfareportingV3_0::Project + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of projects, possibly filtered. This method supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] advertiser_ids + # Select only projects with these advertiser IDs. + # @param [Array, Fixnum] ids + # Select only projects with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for projects by name or ID. Wildcards (*) are allowed. For + # example, "project*2015" will return projects with names like "project June + # 2015", "project April 2015", or simply "project 2015". Most of the searches + # also add wildcards implicitly at the start and the end of the search string. + # For example, a search string of "project" will match projects with name "my + # project", "project 2015", or simply "project". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::ProjectsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::ProjectsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_projects(profile_id, advertiser_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/projects', options) + command.response_representation = Google::Apis::DfareportingV3_0::ProjectsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::ProjectsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserIds'] = advertiser_ids unless advertiser_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of regions. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::RegionsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::RegionsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_regions(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/regions', options) + command.response_representation = Google::Apis::DfareportingV3_0::RegionsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::RegionsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one remarketing list share by remarketing list ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] remarketing_list_id + # Remarketing list ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingListShare] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::RemarketingListShare] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_remarketing_list_share(profile_id, remarketing_list_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingListShares/{remarketingListId}', options) + command.response_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation + command.response_class = Google::Apis::DfareportingV3_0::RemarketingListShare + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['remarketingListId'] = remarketing_list_id unless remarketing_list_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing remarketing list share. This method supports patch + # semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] remarketing_list_id + # Remarketing list ID. + # @param [Google::Apis::DfareportingV3_0::RemarketingListShare] remarketing_list_share_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingListShare] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::RemarketingListShare] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_remarketing_list_share(profile_id, remarketing_list_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/remarketingListShares', options) + command.request_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation + command.request_object = remarketing_list_share_object + command.response_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation + command.response_class = Google::Apis::DfareportingV3_0::RemarketingListShare + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['remarketingListId'] = remarketing_list_id unless remarketing_list_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing remarketing list share. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::RemarketingListShare] remarketing_list_share_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingListShare] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::RemarketingListShare] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_remarketing_list_share(profile_id, remarketing_list_share_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/remarketingListShares', options) + command.request_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation + command.request_object = remarketing_list_share_object + command.response_representation = Google::Apis::DfareportingV3_0::RemarketingListShare::Representation + command.response_class = Google::Apis::DfareportingV3_0::RemarketingListShare + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one remarketing list by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Remarketing list ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::RemarketingList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_remarketing_list(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingLists/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation + command.response_class = Google::Apis::DfareportingV3_0::RemarketingList + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new remarketing list. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::RemarketingList] remarketing_list_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::RemarketingList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/remarketingLists', options) + command.request_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation + command.request_object = remarketing_list_object + command.response_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation + command.response_class = Google::Apis::DfareportingV3_0::RemarketingList + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of remarketing lists, possibly filtered. This method supports + # paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] advertiser_id + # Select only remarketing lists owned by this advertiser. + # @param [Boolean] active + # Select only active or only inactive remarketing lists. + # @param [Fixnum] floodlight_activity_id + # Select only remarketing lists that have this floodlight activity ID. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] name + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "remarketing list*2015" will return objects with names like " + # remarketing list June 2015", "remarketing list April 2015", or simply " + # remarketing list 2015". Most of the searches also add wildcards implicitly at + # the start and the end of the search string. For example, a search string of " + # remarketing list" will match objects with name "my remarketing list", " + # remarketing list 2015", or simply "remarketing list". + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingListsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::RemarketingListsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_remarketing_lists(profile_id, advertiser_id, active: nil, floodlight_activity_id: nil, max_results: nil, name: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/remarketingLists', options) + command.response_representation = Google::Apis::DfareportingV3_0::RemarketingListsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::RemarketingListsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['active'] = active unless active.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['floodlightActivityId'] = floodlight_activity_id unless floodlight_activity_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['name'] = name unless name.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing remarketing list. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Remarketing list ID. + # @param [Google::Apis::DfareportingV3_0::RemarketingList] remarketing_list_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::RemarketingList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_remarketing_list(profile_id, id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/remarketingLists', options) + command.request_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation + command.request_object = remarketing_list_object + command.response_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation + command.response_class = Google::Apis::DfareportingV3_0::RemarketingList + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing remarketing list. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::RemarketingList] remarketing_list_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::RemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::RemarketingList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_remarketing_list(profile_id, remarketing_list_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/remarketingLists', options) + command.request_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation + command.request_object = remarketing_list_object + command.response_representation = Google::Apis::DfareportingV3_0::RemarketingList::Representation + command.response_class = Google::Apis::DfareportingV3_0::RemarketingList + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a report by its ID. + # @param [Fixnum] profile_id + # The DFA user profile ID. + # @param [Fixnum] report_id + # The ID of the report. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_report(profile_id, report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/reports/{reportId}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['reportId'] = report_id unless report_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a report by its ID. + # @param [Fixnum] profile_id + # The DFA user profile ID. + # @param [Fixnum] report_id + # The ID of the report. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Report] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Report] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_report(profile_id, report_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}', options) + command.response_representation = Google::Apis::DfareportingV3_0::Report::Representation + command.response_class = Google::Apis::DfareportingV3_0::Report + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['reportId'] = report_id unless report_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Creates a report. + # @param [Fixnum] profile_id + # The DFA user profile ID. + # @param [Google::Apis::DfareportingV3_0::Report] report_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Report] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Report] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_report(profile_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/reports', options) + command.request_representation = Google::Apis::DfareportingV3_0::Report::Representation + command.request_object = report_object + command.response_representation = Google::Apis::DfareportingV3_0::Report::Representation + command.response_class = Google::Apis::DfareportingV3_0::Report + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves list of reports. + # @param [Fixnum] profile_id + # The DFA user profile ID. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # The value of the nextToken from the previous result page. + # @param [String] scope + # The scope that defines which results are returned. + # @param [String] sort_field + # The field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::ReportList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::ReportList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_reports(profile_id, max_results: nil, page_token: nil, scope: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/reports', options) + command.response_representation = Google::Apis::DfareportingV3_0::ReportList::Representation + command.response_class = Google::Apis::DfareportingV3_0::ReportList + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['scope'] = scope unless scope.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates a report. This method supports patch semantics. + # @param [Fixnum] profile_id + # The DFA user profile ID. + # @param [Fixnum] report_id + # The ID of the report. + # @param [Google::Apis::DfareportingV3_0::Report] report_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Report] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Report] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/reports/{reportId}', options) + command.request_representation = Google::Apis::DfareportingV3_0::Report::Representation + command.request_object = report_object + command.response_representation = Google::Apis::DfareportingV3_0::Report::Representation + command.response_class = Google::Apis::DfareportingV3_0::Report + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['reportId'] = report_id unless report_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Runs a report. + # @param [Fixnum] profile_id + # The DFA profile ID. + # @param [Fixnum] report_id + # The ID of the report. + # @param [Boolean] synchronous + # If set and true, tries to run the report synchronously. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::File] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::File] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def run_report(profile_id, report_id, synchronous: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/reports/{reportId}/run', options) + command.response_representation = Google::Apis::DfareportingV3_0::File::Representation + command.response_class = Google::Apis::DfareportingV3_0::File + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['reportId'] = report_id unless report_id.nil? + command.query['synchronous'] = synchronous unless synchronous.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates a report. + # @param [Fixnum] profile_id + # The DFA user profile ID. + # @param [Fixnum] report_id + # The ID of the report. + # @param [Google::Apis::DfareportingV3_0::Report] report_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Report] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Report] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_report(profile_id, report_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/reports/{reportId}', options) + command.request_representation = Google::Apis::DfareportingV3_0::Report::Representation + command.request_object = report_object + command.response_representation = Google::Apis::DfareportingV3_0::Report::Representation + command.response_class = Google::Apis::DfareportingV3_0::Report + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['reportId'] = report_id unless report_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Returns the fields that are compatible to be selected in the respective + # sections of a report criteria, given the fields already selected in the input + # report and user permissions. + # @param [Fixnum] profile_id + # The DFA user profile ID. + # @param [Google::Apis::DfareportingV3_0::Report] report_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::CompatibleFields] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::CompatibleFields] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def query_report_compatible_field(profile_id, report_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/reports/compatiblefields/query', options) + command.request_representation = Google::Apis::DfareportingV3_0::Report::Representation + command.request_object = report_object + command.response_representation = Google::Apis::DfareportingV3_0::CompatibleFields::Representation + command.response_class = Google::Apis::DfareportingV3_0::CompatibleFields + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a report file. This method supports media download. + # @param [Fixnum] profile_id + # The DFA profile ID. + # @param [Fixnum] report_id + # The ID of the report. + # @param [Fixnum] file_id + # The ID of the report file. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [IO, String] download_dest + # IO stream or filename to receive content download + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::File] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::File] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_report_file(profile_id, report_id, file_id, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) + if download_dest.nil? + command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files/{fileId}', options) + else + command = make_download_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files/{fileId}', options) + command.download_dest = download_dest + end + command.response_representation = Google::Apis::DfareportingV3_0::File::Representation + command.response_class = Google::Apis::DfareportingV3_0::File + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['reportId'] = report_id unless report_id.nil? + command.params['fileId'] = file_id unless file_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists files for a report. + # @param [Fixnum] profile_id + # The DFA profile ID. + # @param [Fixnum] report_id + # The ID of the parent report. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # The value of the nextToken from the previous result page. + # @param [String] sort_field + # The field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::FileList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::FileList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_report_files(profile_id, report_id, max_results: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/reports/{reportId}/files', options) + command.response_representation = Google::Apis::DfareportingV3_0::FileList::Representation + command.response_class = Google::Apis::DfareportingV3_0::FileList + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['reportId'] = report_id unless report_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one site by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Site ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Site] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Site] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_site(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/sites/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::Site::Representation + command.response_class = Google::Apis::DfareportingV3_0::Site + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new site. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Site] site_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Site] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Site] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_site(profile_id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/sites', options) + command.request_representation = Google::Apis::DfareportingV3_0::Site::Representation + command.request_object = site_object + command.response_representation = Google::Apis::DfareportingV3_0::Site::Representation + command.response_class = Google::Apis::DfareportingV3_0::Site + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of sites, possibly filtered. This method supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Boolean] accepts_in_stream_video_placements + # This search filter is no longer supported and will have no effect on the + # results returned. + # @param [Boolean] accepts_interstitial_placements + # This search filter is no longer supported and will have no effect on the + # results returned. + # @param [Boolean] accepts_publisher_paid_placements + # Select only sites that accept publisher paid placements. + # @param [Boolean] ad_words_site + # Select only AdWords sites. + # @param [Boolean] approved + # Select only approved sites. + # @param [Array, Fixnum] campaign_ids + # Select only sites with these campaign IDs. + # @param [Array, Fixnum] directory_site_ids + # Select only sites with these directory site IDs. + # @param [Array, Fixnum] ids + # Select only sites with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. + # For example, "site*2015" will return objects with names like "site June 2015", + # "site April 2015", or simply "site 2015". Most of the searches also add + # wildcards implicitly at the start and the end of the search string. For + # example, a search string of "site" will match objects with name "my site", " + # site 2015", or simply "site". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [Fixnum] subaccount_id + # Select only sites with this subaccount ID. + # @param [Boolean] unmapped_site + # Select only sites that have not been mapped to a directory site. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::SitesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::SitesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_sites(profile_id, accepts_in_stream_video_placements: nil, accepts_interstitial_placements: nil, accepts_publisher_paid_placements: nil, ad_words_site: nil, approved: nil, campaign_ids: nil, directory_site_ids: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, unmapped_site: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/sites', options) + command.response_representation = Google::Apis::DfareportingV3_0::SitesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::SitesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['acceptsInStreamVideoPlacements'] = accepts_in_stream_video_placements unless accepts_in_stream_video_placements.nil? + command.query['acceptsInterstitialPlacements'] = accepts_interstitial_placements unless accepts_interstitial_placements.nil? + command.query['acceptsPublisherPaidPlacements'] = accepts_publisher_paid_placements unless accepts_publisher_paid_placements.nil? + command.query['adWordsSite'] = ad_words_site unless ad_words_site.nil? + command.query['approved'] = approved unless approved.nil? + command.query['campaignIds'] = campaign_ids unless campaign_ids.nil? + command.query['directorySiteIds'] = directory_site_ids unless directory_site_ids.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? + command.query['unmappedSite'] = unmapped_site unless unmapped_site.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing site. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Site ID. + # @param [Google::Apis::DfareportingV3_0::Site] site_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Site] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Site] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_site(profile_id, id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/sites', options) + command.request_representation = Google::Apis::DfareportingV3_0::Site::Representation + command.request_object = site_object + command.response_representation = Google::Apis::DfareportingV3_0::Site::Representation + command.response_class = Google::Apis::DfareportingV3_0::Site + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing site. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Site] site_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Site] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Site] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_site(profile_id, site_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/sites', options) + command.request_representation = Google::Apis::DfareportingV3_0::Site::Representation + command.request_object = site_object + command.response_representation = Google::Apis::DfareportingV3_0::Site::Representation + command.response_class = Google::Apis::DfareportingV3_0::Site + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one size by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Size ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Size] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Size] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_size(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/sizes/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::Size::Representation + command.response_class = Google::Apis::DfareportingV3_0::Size + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new size. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Size] size_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Size] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Size] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_size(profile_id, size_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/sizes', options) + command.request_representation = Google::Apis::DfareportingV3_0::Size::Representation + command.request_object = size_object + command.response_representation = Google::Apis::DfareportingV3_0::Size::Representation + command.response_class = Google::Apis::DfareportingV3_0::Size + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of sizes, possibly filtered. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] height + # Select only sizes with this height. + # @param [Boolean] iab_standard + # Select only IAB standard sizes. + # @param [Array, Fixnum] ids + # Select only sizes with these IDs. + # @param [Fixnum] width + # Select only sizes with this width. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::SizesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::SizesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_sizes(profile_id, height: nil, iab_standard: nil, ids: nil, width: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/sizes', options) + command.response_representation = Google::Apis::DfareportingV3_0::SizesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::SizesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['height'] = height unless height.nil? + command.query['iabStandard'] = iab_standard unless iab_standard.nil? + command.query['ids'] = ids unless ids.nil? + command.query['width'] = width unless width.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one subaccount by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Subaccount ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Subaccount] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Subaccount] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_subaccount(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/subaccounts/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation + command.response_class = Google::Apis::DfareportingV3_0::Subaccount + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new subaccount. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Subaccount] subaccount_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Subaccount] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Subaccount] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/subaccounts', options) + command.request_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation + command.request_object = subaccount_object + command.response_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation + command.response_class = Google::Apis::DfareportingV3_0::Subaccount + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets a list of subaccounts, possibly filtered. This method supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] ids + # Select only subaccounts with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "subaccount*2015" will return objects with names like "subaccount + # June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the + # searches also add wildcards implicitly at the start and the end of the search + # string. For example, a search string of "subaccount" will match objects with + # name "my subaccount", "subaccount 2015", or simply "subaccount". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::SubaccountsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::SubaccountsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_subaccounts(profile_id, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/subaccounts', options) + command.response_representation = Google::Apis::DfareportingV3_0::SubaccountsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::SubaccountsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing subaccount. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Subaccount ID. + # @param [Google::Apis::DfareportingV3_0::Subaccount] subaccount_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Subaccount] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Subaccount] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_subaccount(profile_id, id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/subaccounts', options) + command.request_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation + command.request_object = subaccount_object + command.response_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation + command.response_class = Google::Apis::DfareportingV3_0::Subaccount + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing subaccount. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::Subaccount] subaccount_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::Subaccount] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::Subaccount] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_subaccount(profile_id, subaccount_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/subaccounts', options) + command.request_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation + command.request_object = subaccount_object + command.response_representation = Google::Apis::DfareportingV3_0::Subaccount::Representation + command.response_class = Google::Apis::DfareportingV3_0::Subaccount + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one remarketing list by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Remarketing list ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::TargetableRemarketingList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::TargetableRemarketingList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_targetable_remarketing_list(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/targetableRemarketingLists/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::TargetableRemarketingList::Representation + command.response_class = Google::Apis::DfareportingV3_0::TargetableRemarketingList + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of targetable remarketing lists, possibly filtered. This + # method supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] advertiser_id + # Select only targetable remarketing lists targetable by these advertisers. + # @param [Boolean] active + # Select only active or only inactive targetable remarketing lists. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] name + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "remarketing list*2015" will return objects with names like " + # remarketing list June 2015", "remarketing list April 2015", or simply " + # remarketing list 2015". Most of the searches also add wildcards implicitly at + # the start and the end of the search string. For example, a search string of " + # remarketing list" will match objects with name "my remarketing list", " + # remarketing list 2015", or simply "remarketing list". + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::TargetableRemarketingListsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::TargetableRemarketingListsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_targetable_remarketing_lists(profile_id, advertiser_id, active: nil, max_results: nil, name: nil, page_token: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/targetableRemarketingLists', options) + command.response_representation = Google::Apis::DfareportingV3_0::TargetableRemarketingListsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::TargetableRemarketingListsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['active'] = active unless active.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['name'] = name unless name.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one targeting template by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Targeting template ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::TargetingTemplate] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::TargetingTemplate] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_targeting_template(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/targetingTemplates/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation + command.response_class = Google::Apis::DfareportingV3_0::TargetingTemplate + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new targeting template. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::TargetingTemplate] targeting_template_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::TargetingTemplate] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::TargetingTemplate] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_targeting_template(profile_id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/targetingTemplates', options) + command.request_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation + command.request_object = targeting_template_object + command.response_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation + command.response_class = Google::Apis::DfareportingV3_0::TargetingTemplate + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of targeting templates, optionally filtered. This method + # supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] advertiser_id + # Select only targeting templates with this advertiser ID. + # @param [Array, Fixnum] ids + # Select only targeting templates with these IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "template*2015" will return objects with names like "template June + # 2015", "template April 2015", or simply "template 2015". Most of the searches + # also add wildcards implicitly at the start and the end of the search string. + # For example, a search string of "template" will match objects with name "my + # template", "template 2015", or simply "template". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::TargetingTemplatesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::TargetingTemplatesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_targeting_templates(profile_id, advertiser_id: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/targetingTemplates', options) + command.response_representation = Google::Apis::DfareportingV3_0::TargetingTemplatesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::TargetingTemplatesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing targeting template. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Targeting template ID. + # @param [Google::Apis::DfareportingV3_0::TargetingTemplate] targeting_template_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::TargetingTemplate] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::TargetingTemplate] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_targeting_template(profile_id, id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/targetingTemplates', options) + command.request_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation + command.request_object = targeting_template_object + command.response_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation + command.response_class = Google::Apis::DfareportingV3_0::TargetingTemplate + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing targeting template. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::TargetingTemplate] targeting_template_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::TargetingTemplate] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::TargetingTemplate] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_targeting_template(profile_id, targeting_template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/targetingTemplates', options) + command.request_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation + command.request_object = targeting_template_object + command.response_representation = Google::Apis::DfareportingV3_0::TargetingTemplate::Representation + command.response_class = Google::Apis::DfareportingV3_0::TargetingTemplate + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one user profile by ID. + # @param [Fixnum] profile_id + # The user profile ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::UserProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::UserProfile] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_user_profile(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}', options) + command.response_representation = Google::Apis::DfareportingV3_0::UserProfile::Representation + command.response_class = Google::Apis::DfareportingV3_0::UserProfile + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves list of user profiles for a user. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::UserProfileList] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::UserProfileList] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_user_profiles(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles', options) + command.response_representation = Google::Apis::DfareportingV3_0::UserProfileList::Representation + command.response_class = Google::Apis::DfareportingV3_0::UserProfileList + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one user role permission group by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # User role permission group ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::UserRolePermissionGroup] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::UserRolePermissionGroup] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_user_role_permission_group(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissionGroups/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::UserRolePermissionGroup::Representation + command.response_class = Google::Apis::DfareportingV3_0::UserRolePermissionGroup + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets a list of all supported user role permission groups. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::UserRolePermissionGroupsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::UserRolePermissionGroupsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_user_role_permission_groups(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissionGroups', options) + command.response_representation = Google::Apis::DfareportingV3_0::UserRolePermissionGroupsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::UserRolePermissionGroupsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one user role permission by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # User role permission ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::UserRolePermission] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::UserRolePermission] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_user_role_permission(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissions/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::UserRolePermission::Representation + command.response_class = Google::Apis::DfareportingV3_0::UserRolePermission + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets a list of user role permissions, possibly filtered. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Array, Fixnum] ids + # Select only user role permissions with these IDs. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::UserRolePermissionsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::UserRolePermissionsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_user_role_permissions(profile_id, ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/userRolePermissions', options) + command.response_representation = Google::Apis::DfareportingV3_0::UserRolePermissionsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::UserRolePermissionsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['ids'] = ids unless ids.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an existing user role. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # User role ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_user_role(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, 'userprofiles/{profileId}/userRoles/{id}', options) + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one user role by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # User role ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::UserRole] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::UserRole] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_user_role(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/userRoles/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::UserRole::Representation + command.response_class = Google::Apis::DfareportingV3_0::UserRole + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new user role. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::UserRole] user_role_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::UserRole] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::UserRole] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'userprofiles/{profileId}/userRoles', options) + command.request_representation = Google::Apis::DfareportingV3_0::UserRole::Representation + command.request_object = user_role_object + command.response_representation = Google::Apis::DfareportingV3_0::UserRole::Representation + command.response_class = Google::Apis::DfareportingV3_0::UserRole + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of user roles, possibly filtered. This method supports paging. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Boolean] account_user_role_only + # Select only account level user roles not associated with any specific + # subaccount. + # @param [Array, Fixnum] ids + # Select only user roles with the specified IDs. + # @param [Fixnum] max_results + # Maximum number of results to return. + # @param [String] page_token + # Value of the nextPageToken from the previous result page. + # @param [String] search_string + # Allows searching for objects by name or ID. Wildcards (*) are allowed. For + # example, "userrole*2015" will return objects with names like "userrole June + # 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches + # also add wildcards implicitly at the start and the end of the search string. + # For example, a search string of "userrole" will match objects with name "my + # userrole", "userrole 2015", or simply "userrole". + # @param [String] sort_field + # Field by which to sort the list. + # @param [String] sort_order + # Order of sorted results. + # @param [Fixnum] subaccount_id + # Select only user roles that belong to this subaccount. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::UserRolesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::UserRolesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_user_roles(profile_id, account_user_role_only: nil, ids: nil, max_results: nil, page_token: nil, search_string: nil, sort_field: nil, sort_order: nil, subaccount_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/userRoles', options) + command.response_representation = Google::Apis::DfareportingV3_0::UserRolesListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::UserRolesListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['accountUserRoleOnly'] = account_user_role_only unless account_user_role_only.nil? + command.query['ids'] = ids unless ids.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['searchString'] = search_string unless search_string.nil? + command.query['sortField'] = sort_field unless sort_field.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['subaccountId'] = subaccount_id unless subaccount_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing user role. This method supports patch semantics. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # User role ID. + # @param [Google::Apis::DfareportingV3_0::UserRole] user_role_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::UserRole] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::UserRole] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_user_role(profile_id, id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, 'userprofiles/{profileId}/userRoles', options) + command.request_representation = Google::Apis::DfareportingV3_0::UserRole::Representation + command.request_object = user_role_object + command.response_representation = Google::Apis::DfareportingV3_0::UserRole::Representation + command.response_class = Google::Apis::DfareportingV3_0::UserRole + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing user role. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Google::Apis::DfareportingV3_0::UserRole] user_role_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::UserRole] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::UserRole] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_user_role(profile_id, user_role_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'userprofiles/{profileId}/userRoles', options) + command.request_representation = Google::Apis::DfareportingV3_0::UserRole::Representation + command.request_object = user_role_object + command.response_representation = Google::Apis::DfareportingV3_0::UserRole::Representation + command.response_class = Google::Apis::DfareportingV3_0::UserRole + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Gets one video format by ID. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [Fixnum] id + # Video format ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::VideoFormat] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::VideoFormat] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_video_format(profile_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/videoFormats/{id}', options) + command.response_representation = Google::Apis::DfareportingV3_0::VideoFormat::Representation + command.response_class = Google::Apis::DfareportingV3_0::VideoFormat + command.params['profileId'] = profile_id unless profile_id.nil? + command.params['id'] = id unless id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Lists available video formats. + # @param [Fixnum] profile_id + # User profile ID associated with this request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DfareportingV3_0::VideoFormatsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DfareportingV3_0::VideoFormatsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_video_formats(profile_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'userprofiles/{profileId}/videoFormats', options) + command.response_representation = Google::Apis::DfareportingV3_0::VideoFormatsListResponse::Representation + command.response_class = Google::Apis::DfareportingV3_0::VideoFormatsListResponse + command.params['profileId'] = profile_id unless profile_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + end + end + end + end +end diff --git a/generated/google/apis/playmoviespartner_v1.rb b/generated/google/apis/dialogflow_v2beta1.rb similarity index 51% rename from generated/google/apis/playmoviespartner_v1.rb rename to generated/google/apis/dialogflow_v2beta1.rb index fff288845..362b04721 100644 --- a/generated/google/apis/playmoviespartner_v1.rb +++ b/generated/google/apis/dialogflow_v2beta1.rb @@ -12,23 +12,24 @@ # See the License for the specific language governing permissions and # limitations under the License. -require 'google/apis/playmoviespartner_v1/service.rb' -require 'google/apis/playmoviespartner_v1/classes.rb' -require 'google/apis/playmoviespartner_v1/representations.rb' +require 'google/apis/dialogflow_v2beta1/service.rb' +require 'google/apis/dialogflow_v2beta1/classes.rb' +require 'google/apis/dialogflow_v2beta1/representations.rb' module Google module Apis - # Google Play Movies Partner API + # Dialogflow API # - # Gets the delivery status of titles for Google Play Movies Partners. + # An end-to-end development suite for conversational interfaces (e.g., chatbots, + # voice-powered apps and devices). # - # @see https://developers.google.com/playmoviespartner/ - module PlaymoviespartnerV1 - VERSION = 'V1' - REVISION = '20170418' + # @see https://cloud.google.com/dialogflow-enterprise/ + module DialogflowV2beta1 + VERSION = 'V2beta1' + REVISION = '20171115' - # View the digital assets you publish on Google Play Movies and TV - AUTH_PLAYMOVIES_PARTNER_READONLY = 'https://www.googleapis.com/auth/playmovies_partner.readonly' + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' end end end diff --git a/generated/google/apis/dialogflow_v2beta1/classes.rb b/generated/google/apis/dialogflow_v2beta1/classes.rb new file mode 100644 index 000000000..b19f800e7 --- /dev/null +++ b/generated/google/apis/dialogflow_v2beta1/classes.rb @@ -0,0 +1,2536 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DialogflowV2beta1 + + # Represents a conversational agent. + class Agent + include Google::Apis::Core::Hashable + + # Optional. The URI of the agent's avatar. + # Avatars are used throughout API.AI console and in the self-hosted + # [Web Demo](https://dialogflow.com/docs/integrations/web-demo) integration. + # Corresponds to the JSON property `avatarUri` + # @return [String] + attr_accessor :avatar_uri + + # Optional. To filter out false positive results and still get variety in + # matched natural language inputs for your agent, you can tune the machine + # learning classification threshold. If the returned score value is less than + # the threshold value, then a fallback intent is be triggered or, if there + # are no fallback intents defined, no intent will be triggered. The score + # values range from 0.0 (completely uncertain) to 1.0 (completely certain). + # If set to 0.0, the default of 0.3 is used. + # Corresponds to the JSON property `classificationThreshold` + # @return [Float] + attr_accessor :classification_threshold + + # Required. The default language of the agent as a language tag. See + # [Language Support](https://dialogflow.com/docs/reference/language) for a + # list of the currently supported language codes. + # This field cannot be set by the `Update` method. + # Corresponds to the JSON property `defaultLanguageCode` + # @return [String] + attr_accessor :default_language_code + + # Optional. The description of this agent. + # The maximum length is 500 characters. If exceeded, the request is rejected. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Required. The name of this agent. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Optional. Determines whether this agent should log conversation queries. + # Corresponds to the JSON property `enableLogging` + # @return [Boolean] + attr_accessor :enable_logging + alias_method :enable_logging?, :enable_logging + + # Optional. Determines how intents are detected from user queries. + # Corresponds to the JSON property `matchMode` + # @return [String] + attr_accessor :match_mode + + # Required. The project of this agent. + # Format: `projects/`. + # Corresponds to the JSON property `parent` + # @return [String] + attr_accessor :parent + + # Optional. The list of all languages supported by this agent (except for the + # `default_language_code`). + # Corresponds to the JSON property `supportedLanguageCodes` + # @return [Array] + attr_accessor :supported_language_codes + + # Required. The time zone of this agent from the + # [time zone database](https://www.iana.org/time-zones), e.g., + # America/New_York, Europe/Paris. + # Corresponds to the JSON property `timeZone` + # @return [String] + attr_accessor :time_zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @avatar_uri = args[:avatar_uri] if args.key?(:avatar_uri) + @classification_threshold = args[:classification_threshold] if args.key?(:classification_threshold) + @default_language_code = args[:default_language_code] if args.key?(:default_language_code) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @enable_logging = args[:enable_logging] if args.key?(:enable_logging) + @match_mode = args[:match_mode] if args.key?(:match_mode) + @parent = args[:parent] if args.key?(:parent) + @supported_language_codes = args[:supported_language_codes] if args.key?(:supported_language_codes) + @time_zone = args[:time_zone] if args.key?(:time_zone) + end + end + + # The request message for EntityTypes.BatchCreateEntities. + class BatchCreateEntitiesRequest + include Google::Apis::Core::Hashable + + # Required. The collection of entities to create. + # Corresponds to the JSON property `entities` + # @return [Array] + attr_accessor :entities + + # Optional. The language of entity synonyms defined in `entities`. If not + # specified, the agent's default language is used. + # [More than a dozen + # languages](https://dialogflow.com/docs/reference/language) are supported. + # Note: languages must be enabled in the agent, before they can be used. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entities = args[:entities] if args.key?(:entities) + @language_code = args[:language_code] if args.key?(:language_code) + end + end + + # The request message for EntityTypes.BatchDeleteEntities. + class BatchDeleteEntitiesRequest + include Google::Apis::Core::Hashable + + # Required. The canonical `values` of the entities to delete. Note that + # these are not fully-qualified names, i.e. they don't start with + # `projects/`. + # Corresponds to the JSON property `entityValues` + # @return [Array] + attr_accessor :entity_values + + # Optional. The language of entity synonyms defined in `entities`. If not + # specified, the agent's default language is used. + # [More than a dozen + # languages](https://dialogflow.com/docs/reference/language) are supported. + # Note: languages must be enabled in the agent, before they can be used. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entity_values = args[:entity_values] if args.key?(:entity_values) + @language_code = args[:language_code] if args.key?(:language_code) + end + end + + # The request message for EntityTypes.BatchDeleteEntityTypes. + class BatchDeleteEntityTypesRequest + include Google::Apis::Core::Hashable + + # Required. The names entity types to delete. All names must point to the + # same agent as `parent`. + # Corresponds to the JSON property `entityTypeNames` + # @return [Array] + attr_accessor :entity_type_names + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entity_type_names = args[:entity_type_names] if args.key?(:entity_type_names) + end + end + + # The request message for Intents.BatchDeleteIntents. + class BatchDeleteIntentsRequest + include Google::Apis::Core::Hashable + + # Required. The collection of intents to delete. Only intent `name` must be + # filled in. + # Corresponds to the JSON property `intents` + # @return [Array] + attr_accessor :intents + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @intents = args[:intents] if args.key?(:intents) + end + end + + # The response message for EntityTypes.BatchCreateEntities. + class BatchUpdateEntitiesRequest + include Google::Apis::Core::Hashable + + # Required. The collection of new entities to replace the existing entities. + # Corresponds to the JSON property `entities` + # @return [Array] + attr_accessor :entities + + # Optional. The language of entity synonyms defined in `entities`. If not + # specified, the agent's default language is used. + # [More than a dozen + # languages](https://dialogflow.com/docs/reference/language) are supported. + # Note: languages must be enabled in the agent, before they can be used. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Optional. The mask to control which fields get updated. + # Corresponds to the JSON property `updateMask` + # @return [String] + attr_accessor :update_mask + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entities = args[:entities] if args.key?(:entities) + @language_code = args[:language_code] if args.key?(:language_code) + @update_mask = args[:update_mask] if args.key?(:update_mask) + end + end + + # The request message for EntityTypes.BatchUpdateEntityTypes. + class BatchUpdateEntityTypesRequest + include Google::Apis::Core::Hashable + + # This message is a wrapper around a collection of entity types. + # Corresponds to the JSON property `entityTypeBatchInline` + # @return [Google::Apis::DialogflowV2beta1::EntityTypeBatch] + attr_accessor :entity_type_batch_inline + + # Warning: Importing entity types from a URI is not implemented yet. + # This feature is coming soon. + # The URI to a Google Cloud Storage file containing entity types to update + # or create. The file format can either be a serialized proto (of + # EntityBatch type) or a JSON object. Note: The URI must start with + # "gs://". + # Corresponds to the JSON property `entityTypeBatchUri` + # @return [String] + attr_accessor :entity_type_batch_uri + + # Optional. The language of entity synonyms defined in `entity_types`. If not + # specified, the agent's default language is used. + # [More than a dozen + # languages](https://dialogflow.com/docs/reference/language) are supported. + # Note: languages must be enabled in the agent, before they can be used. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Optional. The mask to control which fields get updated. + # Corresponds to the JSON property `updateMask` + # @return [String] + attr_accessor :update_mask + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entity_type_batch_inline = args[:entity_type_batch_inline] if args.key?(:entity_type_batch_inline) + @entity_type_batch_uri = args[:entity_type_batch_uri] if args.key?(:entity_type_batch_uri) + @language_code = args[:language_code] if args.key?(:language_code) + @update_mask = args[:update_mask] if args.key?(:update_mask) + end + end + + # The response message for EntityTypes.BatchUpdateEntityTypes. + class BatchUpdateEntityTypesResponse + include Google::Apis::Core::Hashable + + # The collection of updated or created entity types. + # Corresponds to the JSON property `entityTypes` + # @return [Array] + attr_accessor :entity_types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entity_types = args[:entity_types] if args.key?(:entity_types) + end + end + + # The request message for Intents.BatchUpdateIntents. + class BatchUpdateIntentsRequest + include Google::Apis::Core::Hashable + + # This message is a wrapper around a collection of intents. + # Corresponds to the JSON property `intentBatchInline` + # @return [Google::Apis::DialogflowV2beta1::IntentBatch] + attr_accessor :intent_batch_inline + + # Warning: Importing intents from a URI is not implemented yet. + # This feature is coming soon. + # The URI to a Google Cloud Storage file containing intents to update or + # create. The file format can either be a serialized proto (of IntentBatch + # type) or JSON object. Note: The URI must start with "gs://". + # Corresponds to the JSON property `intentBatchUri` + # @return [String] + attr_accessor :intent_batch_uri + + # Optional. The resource view to apply to the returned intent. + # Corresponds to the JSON property `intentView` + # @return [String] + attr_accessor :intent_view + + # Optional. The language of training phrases, parameters and rich messages + # defined in `intents`. If not specified, the agent's default language is + # used. [More than a dozen + # languages](https://dialogflow.com/docs/reference/language) are supported. + # Note: languages must be enabled in the agent, before they can be used. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Optional. The mask to control which fields get updated. + # Corresponds to the JSON property `updateMask` + # @return [String] + attr_accessor :update_mask + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @intent_batch_inline = args[:intent_batch_inline] if args.key?(:intent_batch_inline) + @intent_batch_uri = args[:intent_batch_uri] if args.key?(:intent_batch_uri) + @intent_view = args[:intent_view] if args.key?(:intent_view) + @language_code = args[:language_code] if args.key?(:language_code) + @update_mask = args[:update_mask] if args.key?(:update_mask) + end + end + + # The response message for Intents.BatchUpdateIntents. + class BatchUpdateIntentsResponse + include Google::Apis::Core::Hashable + + # The collection of updated or created intents. + # Corresponds to the JSON property `intents` + # @return [Array] + attr_accessor :intents + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @intents = args[:intents] if args.key?(:intents) + end + end + + # Represents a context. + class Context + include Google::Apis::Core::Hashable + + # Optional. The number of conversational query requests after which the + # context expires. If set to `0` (the default) the context expires + # immediately. Contexts expire automatically after 10 minutes even if there + # are no matching queries. + # Corresponds to the JSON property `lifespanCount` + # @return [Fixnum] + attr_accessor :lifespan_count + + # Required. The unique identifier of the context. Format: + # `projects//agent/sessions//contexts/`. + # Note: The Context ID is always converted to lowercase. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Optional. The collection of parameters associated with this context. + # Refer to [this doc](https://dialogflow.com/docs/actions-and-parameters) for + # syntax. + # Corresponds to the JSON property `parameters` + # @return [Hash] + attr_accessor :parameters + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @lifespan_count = args[:lifespan_count] if args.key?(:lifespan_count) + @name = args[:name] if args.key?(:name) + @parameters = args[:parameters] if args.key?(:parameters) + end + end + + # The request to detect user's intent. + class DetectIntentRequest + include Google::Apis::Core::Hashable + + # Optional. The natural language speech audio to be processed. This field + # should be populated iff `query_input` is set to an input audio config. + # A single request can contain up to 1 minute of speech audio data. + # Corresponds to the JSON property `inputAudio` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :input_audio + + # Represents the query input. It can contain either: + # 1. an audio config which + # instructs the speech recognizer how to process the speech audio, + # 2. a conversational query in the form of text, or + # 3. an event that specifies which intent to trigger. + # Corresponds to the JSON property `queryInput` + # @return [Google::Apis::DialogflowV2beta1::QueryInput] + attr_accessor :query_input + + # Represents the parameters of the conversational query. + # Corresponds to the JSON property `queryParams` + # @return [Google::Apis::DialogflowV2beta1::QueryParameters] + attr_accessor :query_params + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @input_audio = args[:input_audio] if args.key?(:input_audio) + @query_input = args[:query_input] if args.key?(:query_input) + @query_params = args[:query_params] if args.key?(:query_params) + end + end + + # The message returned from the DetectIntent method. + class DetectIntentResponse + include Google::Apis::Core::Hashable + + # Represents the result of conversational query or event processing. + # Corresponds to the JSON property `queryResult` + # @return [Google::Apis::DialogflowV2beta1::QueryResult] + attr_accessor :query_result + + # The unique identifier of the response. It can be used to + # locate a response in the training example set or for reporting issues. + # Corresponds to the JSON property `responseId` + # @return [String] + attr_accessor :response_id + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by + # [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error message, + # and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + # Corresponds to the JSON property `webhookStatus` + # @return [Google::Apis::DialogflowV2beta1::Status] + attr_accessor :webhook_status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @query_result = args[:query_result] if args.key?(:query_result) + @response_id = args[:response_id] if args.key?(:response_id) + @webhook_status = args[:webhook_status] if args.key?(:webhook_status) + end + end + + # 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); + # ` + # The JSON representation for `Empty` is empty JSON object ````. + class Empty + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Represents an entity type. + # Entity types serve as a tool for extracting parameter values from natural + # language queries. + class EntityType + include Google::Apis::Core::Hashable + + # Optional. Indicates whether the entity type can be automatically + # expanded. + # Corresponds to the JSON property `autoExpansionMode` + # @return [String] + attr_accessor :auto_expansion_mode + + # Required. The name of the entity. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Optional. The collection of entities associated with the entity type. + # Corresponds to the JSON property `entities` + # @return [Array] + attr_accessor :entities + + # Required. Indicates the kind of entity type. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Required for all methods except `create` (`create` populates the name + # automatically. + # The unique identifier of the entity type. Format: + # `projects//agent/entityTypes/`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @auto_expansion_mode = args[:auto_expansion_mode] if args.key?(:auto_expansion_mode) + @display_name = args[:display_name] if args.key?(:display_name) + @entities = args[:entities] if args.key?(:entities) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # This message is a wrapper around a collection of entity types. + class EntityTypeBatch + include Google::Apis::Core::Hashable + + # A collection of entity types. + # Corresponds to the JSON property `entityTypes` + # @return [Array] + attr_accessor :entity_types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entity_types = args[:entity_types] if args.key?(:entity_types) + end + end + + # Optional. Represents an entity. + class EntityTypeEntity + include Google::Apis::Core::Hashable + + # Required. A collection of synonyms. For `KIND_LIST` entity types this + # must contain exactly one synonym equal to `value`. + # Corresponds to the JSON property `synonyms` + # @return [Array] + attr_accessor :synonyms + + # Required. + # For `KIND_MAP` entity types: + # A canonical name to be used in place of synonyms. + # For `KIND_LIST` entity types: + # A string that can contain references to other entity types (with or + # without aliases). + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @synonyms = args[:synonyms] if args.key?(:synonyms) + @value = args[:value] if args.key?(:value) + end + end + + # Events allow for matching intents by event name instead of the natural + # language input. For instance, input `` can trigger a personalized welcome response. + # The parameter `name` may be used by the agent in the response: + # `“Hello #welcome_event.name! What can I do for you today?”`. + class EventInput + include Google::Apis::Core::Hashable + + # Required. The language of this query. See [Language + # Support](https://dialogflow.com/docs/languages) for a list of the + # currently supported language codes. Note that queries in the same session + # do not necessarily need to specify the same language. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Required. The unique identifier of the event. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Optional. The collection of parameters associated with the event. + # Corresponds to the JSON property `parameters` + # @return [Hash] + attr_accessor :parameters + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @language_code = args[:language_code] if args.key?(:language_code) + @name = args[:name] if args.key?(:name) + @parameters = args[:parameters] if args.key?(:parameters) + end + end + + # The request message for Agents.ExportAgent. + class ExportAgentRequest + include Google::Apis::Core::Hashable + + # Warning: Exporting agents to a URI is not implemented yet. + # This feature is coming soon. + # Optional. The Google Cloud Storage URI to export the agent to. + # Note: The URI must start with + # "gs://". If left unspecified, the serialized agent is returned inline. + # Corresponds to the JSON property `agentUri` + # @return [String] + attr_accessor :agent_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agent_uri = args[:agent_uri] if args.key?(:agent_uri) + end + end + + # The response message for Agents.ExportAgent. + class ExportAgentResponse + include Google::Apis::Core::Hashable + + # The exported agent. + # Corresponds to the JSON property `agentContent` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :agent_content + + # The URI to a file containing the exported agent. This field is populated + # only if `agent_uri` + # Corresponds to the JSON property `agentUri` + # @return [String] + attr_accessor :agent_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agent_content = args[:agent_content] if args.key?(:agent_content) + @agent_uri = args[:agent_uri] if args.key?(:agent_uri) + end + end + + # The request message for Agents.ImportAgent. + class ImportAgentRequest + include Google::Apis::Core::Hashable + + # The agent to import. + # Corresponds to the JSON property `agentContent` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :agent_content + + # Warning: Importing agents from a URI is not implemented yet. + # This feature is coming soon. + # The URI to a Google Cloud Storage file containing the agent to import. + # Note: The URI must start with "gs://". + # Corresponds to the JSON property `agentUri` + # @return [String] + attr_accessor :agent_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agent_content = args[:agent_content] if args.key?(:agent_content) + @agent_uri = args[:agent_uri] if args.key?(:agent_uri) + end + end + + # Instructs the speech recognizer how to process the audio content. + class InputAudioConfig + include Google::Apis::Core::Hashable + + # Required. Audio encoding of the audio content to process. + # Corresponds to the JSON property `audioEncoding` + # @return [String] + attr_accessor :audio_encoding + + # Required. The language of the supplied audio. Dialogflow does not do + # translations. See [Language + # Support](https://dialogflow.com/docs/languages) for a list of the + # currently supported language codes. Note that queries in the same session + # do not necessarily need to specify the same language. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Optional. The collection of phrase hints which are used to boost accuracy + # of speech recognition. + # Refer to [Cloud Speech API documentation](/speech/docs/basics#phrase-hints) + # for more details. + # Corresponds to the JSON property `phraseHints` + # @return [Array] + attr_accessor :phrase_hints + + # Required. Sample rate (in Hertz) of the audio content sent in the query. + # Refer to [Cloud Speech API documentation](/speech/docs/basics) for more + # details. + # Corresponds to the JSON property `sampleRateHertz` + # @return [Fixnum] + attr_accessor :sample_rate_hertz + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audio_encoding = args[:audio_encoding] if args.key?(:audio_encoding) + @language_code = args[:language_code] if args.key?(:language_code) + @phrase_hints = args[:phrase_hints] if args.key?(:phrase_hints) + @sample_rate_hertz = args[:sample_rate_hertz] if args.key?(:sample_rate_hertz) + end + end + + # Represents an intent. + # Intents convert a number of user expressions or patterns into an action. An + # action is an extraction of a user command or sentence semantics. + class Intent + include Google::Apis::Core::Hashable + + # Optional. The name of the action associated with the intent. + # Corresponds to the JSON property `action` + # @return [String] + attr_accessor :action + + # Optional. The list of platforms for which the first response will be + # taken from among the messages assigned to the DEFAULT_PLATFORM. + # Corresponds to the JSON property `defaultResponsePlatforms` + # @return [Array] + attr_accessor :default_response_platforms + + # Required. The name of this intent. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Optional. The collection of event names that trigger the intent. + # If the collection of input contexts is not empty, all of the contexts must + # be present in the active user session for an event to trigger this intent. + # Corresponds to the JSON property `events` + # @return [Array] + attr_accessor :events + + # Optional. Collection of information about all followup intents that have + # name of this intent as a root_name. + # Corresponds to the JSON property `followupIntentInfo` + # @return [Array] + attr_accessor :followup_intent_info + + # Optional. The list of context names required for this intent to be + # triggered. + # Format: `projects//agent/sessions/-/contexts/`. + # Corresponds to the JSON property `inputContextNames` + # @return [Array] + attr_accessor :input_context_names + + # Optional. Indicates whether this is a fallback intent. + # Corresponds to the JSON property `isFallback` + # @return [Boolean] + attr_accessor :is_fallback + alias_method :is_fallback?, :is_fallback + + # Optional. The collection of rich messages corresponding to the + # `Response` field in API.AI console. + # Corresponds to the JSON property `messages` + # @return [Array] + attr_accessor :messages + + # Optional. Indicates whether Machine Learning is enabled for the intent. + # Note: If `ml_enabled` setting is set to false, then this intent is not + # taken into account during inference in `ML ONLY` match mode. Also, + # auto-markup in the UI is turned off. + # Corresponds to the JSON property `mlEnabled` + # @return [Boolean] + attr_accessor :ml_enabled + alias_method :ml_enabled?, :ml_enabled + + # Required for all methods except `create` (`create` populates the name + # automatically. + # The unique identifier of this intent. + # Format: `projects//agent/intents/`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Optional. The collection of contexts that are activated when the intent + # is matched. Context messages in this collection should not set the + # parameters field. Setting the `lifespan_count` to 0 will reset the context + # when the intent is matched. + # Format: `projects//agent/sessions/-/contexts/`. + # Corresponds to the JSON property `outputContexts` + # @return [Array] + attr_accessor :output_contexts + + # Optional. The collection of parameters associated with the intent. + # Corresponds to the JSON property `parameters` + # @return [Array] + attr_accessor :parameters + + # The unique identifier of the parent intent in the chain of followup + # intents. + # It identifies the parent followup intent. + # Format: `projects//agent/intents/`. + # Corresponds to the JSON property `parentFollowupIntentName` + # @return [String] + attr_accessor :parent_followup_intent_name + + # Optional. The priority of this intent. Higher numbers represent higher + # priorities. Zero or negative numbers mean that the intent is disabled. + # Corresponds to the JSON property `priority` + # @return [Fixnum] + attr_accessor :priority + + # Optional. Indicates whether to delete all contexts in the current + # session when this intent is matched. + # Corresponds to the JSON property `resetContexts` + # @return [Boolean] + attr_accessor :reset_contexts + alias_method :reset_contexts?, :reset_contexts + + # The unique identifier of the root intent in the chain of followup intents. + # It identifies the correct followup intents chain for this intent. + # Format: `projects//agent/intents/`. + # Corresponds to the JSON property `rootFollowupIntentName` + # @return [String] + attr_accessor :root_followup_intent_name + + # Optional. The collection of examples/templates that the agent is + # trained on. + # Corresponds to the JSON property `trainingPhrases` + # @return [Array] + attr_accessor :training_phrases + + # Required. Indicates whether webhooks are enabled for the intent. + # Corresponds to the JSON property `webhookState` + # @return [String] + attr_accessor :webhook_state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] if args.key?(:action) + @default_response_platforms = args[:default_response_platforms] if args.key?(:default_response_platforms) + @display_name = args[:display_name] if args.key?(:display_name) + @events = args[:events] if args.key?(:events) + @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info) + @input_context_names = args[:input_context_names] if args.key?(:input_context_names) + @is_fallback = args[:is_fallback] if args.key?(:is_fallback) + @messages = args[:messages] if args.key?(:messages) + @ml_enabled = args[:ml_enabled] if args.key?(:ml_enabled) + @name = args[:name] if args.key?(:name) + @output_contexts = args[:output_contexts] if args.key?(:output_contexts) + @parameters = args[:parameters] if args.key?(:parameters) + @parent_followup_intent_name = args[:parent_followup_intent_name] if args.key?(:parent_followup_intent_name) + @priority = args[:priority] if args.key?(:priority) + @reset_contexts = args[:reset_contexts] if args.key?(:reset_contexts) + @root_followup_intent_name = args[:root_followup_intent_name] if args.key?(:root_followup_intent_name) + @training_phrases = args[:training_phrases] if args.key?(:training_phrases) + @webhook_state = args[:webhook_state] if args.key?(:webhook_state) + end + end + + # This message is a wrapper around a collection of intents. + class IntentBatch + include Google::Apis::Core::Hashable + + # A collection of intents. + # Corresponds to the JSON property `intents` + # @return [Array] + attr_accessor :intents + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @intents = args[:intents] if args.key?(:intents) + end + end + + # Represents a single followup intent in the chain. + class IntentFollowupIntentInfo + include Google::Apis::Core::Hashable + + # The unique identifier of the followup intent. + # Format: `projects//agent/intents/`. + # Corresponds to the JSON property `followupIntentName` + # @return [String] + attr_accessor :followup_intent_name + + # The unique identifier of the followup intent parent. + # Format: `projects//agent/intents/`. + # Corresponds to the JSON property `parentFollowupIntentName` + # @return [String] + attr_accessor :parent_followup_intent_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @followup_intent_name = args[:followup_intent_name] if args.key?(:followup_intent_name) + @parent_followup_intent_name = args[:parent_followup_intent_name] if args.key?(:parent_followup_intent_name) + end + end + + # Corresponds to the `Response` field in API.AI console. + class IntentMessage + include Google::Apis::Core::Hashable + + # The basic card message. Useful for displaying information. + # Corresponds to the JSON property `basicCard` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageBasicCard] + attr_accessor :basic_card + + # The card response message. + # Corresponds to the JSON property `card` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageCard] + attr_accessor :card + + # The card for presenting a carousel of options to select from. + # Corresponds to the JSON property `carouselSelect` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageCarouselSelect] + attr_accessor :carousel_select + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageImage] + attr_accessor :image + + # The suggestion chip message that allows the user to jump out to the app + # or website associated with this agent. + # Corresponds to the JSON property `linkOutSuggestion` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageLinkOutSuggestion] + attr_accessor :link_out_suggestion + + # The card for presenting a list of options to select from. + # Corresponds to the JSON property `listSelect` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageListSelect] + attr_accessor :list_select + + # The response containing a custom payload. + # Corresponds to the JSON property `payload` + # @return [Hash] + attr_accessor :payload + + # Optional. The platform that this message is intended for. + # Corresponds to the JSON property `platform` + # @return [String] + attr_accessor :platform + + # The quick replies response message. + # Corresponds to the JSON property `quickReplies` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageQuickReplies] + attr_accessor :quick_replies + + # The collection of simple response candidates. + # This message in `QueryResult.fulfillment_messages` and + # `WebhookResponse.fulfillment_messages` should contain only one + # `SimpleResponse`. + # Corresponds to the JSON property `simpleResponses` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageSimpleResponses] + attr_accessor :simple_responses + + # The collection of suggestions. + # Corresponds to the JSON property `suggestions` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageSuggestions] + attr_accessor :suggestions + + # The text response message. + # Corresponds to the JSON property `text` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageText] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @basic_card = args[:basic_card] if args.key?(:basic_card) + @card = args[:card] if args.key?(:card) + @carousel_select = args[:carousel_select] if args.key?(:carousel_select) + @image = args[:image] if args.key?(:image) + @link_out_suggestion = args[:link_out_suggestion] if args.key?(:link_out_suggestion) + @list_select = args[:list_select] if args.key?(:list_select) + @payload = args[:payload] if args.key?(:payload) + @platform = args[:platform] if args.key?(:platform) + @quick_replies = args[:quick_replies] if args.key?(:quick_replies) + @simple_responses = args[:simple_responses] if args.key?(:simple_responses) + @suggestions = args[:suggestions] if args.key?(:suggestions) + @text = args[:text] if args.key?(:text) + end + end + + # The basic card message. Useful for displaying information. + class IntentMessageBasicCard + include Google::Apis::Core::Hashable + + # Optional. The collection of card buttons. + # Corresponds to the JSON property `buttons` + # @return [Array] + attr_accessor :buttons + + # Required, unless image is present. The body text of the card. + # Corresponds to the JSON property `formattedText` + # @return [String] + attr_accessor :formatted_text + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageImage] + attr_accessor :image + + # Optional. The subtitle of the card. + # Corresponds to the JSON property `subtitle` + # @return [String] + attr_accessor :subtitle + + # Optional. The title of the card. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @buttons = args[:buttons] if args.key?(:buttons) + @formatted_text = args[:formatted_text] if args.key?(:formatted_text) + @image = args[:image] if args.key?(:image) + @subtitle = args[:subtitle] if args.key?(:subtitle) + @title = args[:title] if args.key?(:title) + end + end + + # The button object that appears at the bottom of a card. + class IntentMessageBasicCardButton + include Google::Apis::Core::Hashable + + # Opens the given URI. + # Corresponds to the JSON property `openUriAction` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageBasicCardButtonOpenUriAction] + attr_accessor :open_uri_action + + # Required. The title of the button. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @open_uri_action = args[:open_uri_action] if args.key?(:open_uri_action) + @title = args[:title] if args.key?(:title) + end + end + + # Opens the given URI. + class IntentMessageBasicCardButtonOpenUriAction + include Google::Apis::Core::Hashable + + # Required. The HTTP or HTTPS scheme URI. + # Corresponds to the JSON property `uri` + # @return [String] + attr_accessor :uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @uri = args[:uri] if args.key?(:uri) + end + end + + # The card response message. + class IntentMessageCard + include Google::Apis::Core::Hashable + + # Optional. The collection of card buttons. + # Corresponds to the JSON property `buttons` + # @return [Array] + attr_accessor :buttons + + # Optional. The public URI to an image file for the card. + # Corresponds to the JSON property `imageUri` + # @return [String] + attr_accessor :image_uri + + # Optional. The subtitle of the card. + # Corresponds to the JSON property `subtitle` + # @return [String] + attr_accessor :subtitle + + # Optional. The title of the card. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @buttons = args[:buttons] if args.key?(:buttons) + @image_uri = args[:image_uri] if args.key?(:image_uri) + @subtitle = args[:subtitle] if args.key?(:subtitle) + @title = args[:title] if args.key?(:title) + end + end + + # Optional. Contains information about a button. + class IntentMessageCardButton + include Google::Apis::Core::Hashable + + # Optional. The text to send back to the Dialogflow API or a URI to + # open. + # Corresponds to the JSON property `postback` + # @return [String] + attr_accessor :postback + + # Optional. The text to show on the button. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @postback = args[:postback] if args.key?(:postback) + @text = args[:text] if args.key?(:text) + end + end + + # The card for presenting a carousel of options to select from. + class IntentMessageCarouselSelect + include Google::Apis::Core::Hashable + + # Required. Carousel items. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @items = args[:items] if args.key?(:items) + end + end + + # An item in the carousel. + class IntentMessageCarouselSelectItem + include Google::Apis::Core::Hashable + + # Optional. The body text of the card. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageImage] + attr_accessor :image + + # Additional info about the select item for when it is triggered in a + # dialog. + # Corresponds to the JSON property `info` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageSelectItemInfo] + attr_accessor :info + + # Required. Title of the carousel item. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @image = args[:image] if args.key?(:image) + @info = args[:info] if args.key?(:info) + @title = args[:title] if args.key?(:title) + end + end + + # The image response message. + class IntentMessageImage + include Google::Apis::Core::Hashable + + # Optional. The public URI to an image file. + # Corresponds to the JSON property `imageUri` + # @return [String] + attr_accessor :image_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @image_uri = args[:image_uri] if args.key?(:image_uri) + end + end + + # The suggestion chip message that allows the user to jump out to the app + # or website associated with this agent. + class IntentMessageLinkOutSuggestion + include Google::Apis::Core::Hashable + + # Required. The name of the app or site this chip is linking to. + # Corresponds to the JSON property `destinationName` + # @return [String] + attr_accessor :destination_name + + # Required. The URI of the app or site to open when the user taps the + # suggestion chip. + # Corresponds to the JSON property `uri` + # @return [String] + attr_accessor :uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @destination_name = args[:destination_name] if args.key?(:destination_name) + @uri = args[:uri] if args.key?(:uri) + end + end + + # The card for presenting a list of options to select from. + class IntentMessageListSelect + include Google::Apis::Core::Hashable + + # Required. List items. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # Optional. The overall title of the list. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @items = args[:items] if args.key?(:items) + @title = args[:title] if args.key?(:title) + end + end + + # An item in the list. + class IntentMessageListSelectItem + include Google::Apis::Core::Hashable + + # Optional. The main text describing the item. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageImage] + attr_accessor :image + + # Additional info about the select item for when it is triggered in a + # dialog. + # Corresponds to the JSON property `info` + # @return [Google::Apis::DialogflowV2beta1::IntentMessageSelectItemInfo] + attr_accessor :info + + # Required. The title of the list item. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @image = args[:image] if args.key?(:image) + @info = args[:info] if args.key?(:info) + @title = args[:title] if args.key?(:title) + end + end + + # The quick replies response message. + class IntentMessageQuickReplies + include Google::Apis::Core::Hashable + + # Optional. The collection of quick replies. + # Corresponds to the JSON property `quickReplies` + # @return [Array] + attr_accessor :quick_replies + + # Optional. The title of the collection of quick replies. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @quick_replies = args[:quick_replies] if args.key?(:quick_replies) + @title = args[:title] if args.key?(:title) + end + end + + # Additional info about the select item for when it is triggered in a + # dialog. + class IntentMessageSelectItemInfo + include Google::Apis::Core::Hashable + + # Required. A unique key that will be sent back to the agent if this + # response is given. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # Optional. A list of synonyms that can also be used to trigger this + # item in dialog. + # Corresponds to the JSON property `synonyms` + # @return [Array] + attr_accessor :synonyms + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key = args[:key] if args.key?(:key) + @synonyms = args[:synonyms] if args.key?(:synonyms) + end + end + + # The simple response message containing speech or text. + class IntentMessageSimpleResponse + include Google::Apis::Core::Hashable + + # Optional. The text to display. + # Corresponds to the JSON property `displayText` + # @return [String] + attr_accessor :display_text + + # One of text_to_speech or ssml must be provided. Structured spoken + # response to the user in the SSML format. Mutually exclusive with + # text_to_speech. + # Corresponds to the JSON property `ssml` + # @return [String] + attr_accessor :ssml + + # One of text_to_speech or ssml must be provided. The plain text of the + # speech output. Mutually exclusive with ssml. + # Corresponds to the JSON property `textToSpeech` + # @return [String] + attr_accessor :text_to_speech + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_text = args[:display_text] if args.key?(:display_text) + @ssml = args[:ssml] if args.key?(:ssml) + @text_to_speech = args[:text_to_speech] if args.key?(:text_to_speech) + end + end + + # The collection of simple response candidates. + # This message in `QueryResult.fulfillment_messages` and + # `WebhookResponse.fulfillment_messages` should contain only one + # `SimpleResponse`. + class IntentMessageSimpleResponses + include Google::Apis::Core::Hashable + + # Required. The list of simple responses. + # Corresponds to the JSON property `simpleResponses` + # @return [Array] + attr_accessor :simple_responses + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @simple_responses = args[:simple_responses] if args.key?(:simple_responses) + end + end + + # The suggestion chip message that the user can tap to quickly post a reply + # to the conversation. + class IntentMessageSuggestion + include Google::Apis::Core::Hashable + + # Required. The text shown the in the suggestion chip. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @title = args[:title] if args.key?(:title) + end + end + + # The collection of suggestions. + class IntentMessageSuggestions + include Google::Apis::Core::Hashable + + # Required. The list of suggested replies. + # Corresponds to the JSON property `suggestions` + # @return [Array] + attr_accessor :suggestions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @suggestions = args[:suggestions] if args.key?(:suggestions) + end + end + + # The text response message. + class IntentMessageText + include Google::Apis::Core::Hashable + + # Optional. The collection of the agent's responses. + # Corresponds to the JSON property `text` + # @return [Array] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @text = args[:text] if args.key?(:text) + end + end + + # Represents intent parameters. + class IntentParameter + include Google::Apis::Core::Hashable + + # Optional. The default value to use when the `value` yields an empty + # result. + # Default values can be extracted from contexts by using the following + # syntax: `#context_name.parameter_name`. + # Corresponds to the JSON property `defaultValue` + # @return [String] + attr_accessor :default_value + + # Required. The name of the parameter. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Optional. The name of the entity type, prefixed with `@`, that + # describes values of the parameter. If the parameter is + # required, this must be provided. + # Corresponds to the JSON property `entityTypeDisplayName` + # @return [String] + attr_accessor :entity_type_display_name + + # Optional. Indicates whether the parameter represents a list of values. + # Corresponds to the JSON property `isList` + # @return [Boolean] + attr_accessor :is_list + alias_method :is_list?, :is_list + + # Optional. Indicates whether the parameter is required. That is, + # whether the intent cannot be completed without collecting the parameter + # value. + # Corresponds to the JSON property `mandatory` + # @return [Boolean] + attr_accessor :mandatory + alias_method :mandatory?, :mandatory + + # The unique identifier of this parameter. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Optional. The collection of prompts that the agent can present to the + # user in order to collect value for the parameter. + # Corresponds to the JSON property `prompts` + # @return [Array] + attr_accessor :prompts + + # Optional. The definition of the parameter value. It can be: + # - a constant string, + # - a parameter value defined as `$parameter_name`, + # - an original parameter value defined as `$parameter_name.original`, + # - a parameter value from some context defined as + # `#context_name.parameter_name`. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @default_value = args[:default_value] if args.key?(:default_value) + @display_name = args[:display_name] if args.key?(:display_name) + @entity_type_display_name = args[:entity_type_display_name] if args.key?(:entity_type_display_name) + @is_list = args[:is_list] if args.key?(:is_list) + @mandatory = args[:mandatory] if args.key?(:mandatory) + @name = args[:name] if args.key?(:name) + @prompts = args[:prompts] if args.key?(:prompts) + @value = args[:value] if args.key?(:value) + end + end + + # Represents an example or template that the agent is trained on. + class IntentTrainingPhrase + include Google::Apis::Core::Hashable + + # Required. The unique identifier of this training phrase. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Required. The collection of training phrase parts (can be annotated). + # Fields: `entity_type`, `alias` and `user_defined` should be populated + # only for the annotated parts of the training phrase. + # Corresponds to the JSON property `parts` + # @return [Array] + attr_accessor :parts + + # Optional. Indicates how many times this example or template was added to + # the intent. Each time a developer adds an existing sample by editing an + # intent or training, this counter is increased. + # Corresponds to the JSON property `timesAddedCount` + # @return [Fixnum] + attr_accessor :times_added_count + + # Required. The type of the training phrase. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @parts = args[:parts] if args.key?(:parts) + @times_added_count = args[:times_added_count] if args.key?(:times_added_count) + @type = args[:type] if args.key?(:type) + end + end + + # Represents a part of a training phrase. + class IntentTrainingPhrasePart + include Google::Apis::Core::Hashable + + # Optional. The parameter name for the value extracted from the + # annotated part of the example. + # Corresponds to the JSON property `alias` + # @return [String] + attr_accessor :alias + + # Optional. The entity type name prefixed with `@`. This field is + # required for the annotated part of the text and applies only to + # examples. + # Corresponds to the JSON property `entityType` + # @return [String] + attr_accessor :entity_type + + # Required. The text corresponding to the example or template, + # if there are no annotations. For + # annotated examples, it is the text for one of the example's parts. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + # Optional. Indicates whether the text was manually annotated by the + # developer. + # Corresponds to the JSON property `userDefined` + # @return [Boolean] + attr_accessor :user_defined + alias_method :user_defined?, :user_defined + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @alias = args[:alias] if args.key?(:alias) + @entity_type = args[:entity_type] if args.key?(:entity_type) + @text = args[:text] if args.key?(:text) + @user_defined = args[:user_defined] if args.key?(:user_defined) + end + end + + # An object representing a latitude/longitude pair. This is expressed as a pair + # of doubles representing degrees latitude and degrees longitude. Unless + # specified otherwise, this must conform to the + # WGS84 + # standard. Values must be within normalized ranges. + class LatLng + include Google::Apis::Core::Hashable + + # The latitude in degrees. It must be in the range [-90.0, +90.0]. + # Corresponds to the JSON property `latitude` + # @return [Float] + attr_accessor :latitude + + # The longitude in degrees. It must be in the range [-180.0, +180.0]. + # Corresponds to the JSON property `longitude` + # @return [Float] + attr_accessor :longitude + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @latitude = args[:latitude] if args.key?(:latitude) + @longitude = args[:longitude] if args.key?(:longitude) + end + end + + # The response message for Contexts.ListContexts. + class ListContextsResponse + include Google::Apis::Core::Hashable + + # The list of contexts. There will be a maximum number of items + # returned based on the page_size field in the request. + # Corresponds to the JSON property `contexts` + # @return [Array] + attr_accessor :contexts + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @contexts = args[:contexts] if args.key?(:contexts) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The response message for EntityTypes.ListEntityTypes. + class ListEntityTypesResponse + include Google::Apis::Core::Hashable + + # The list of agent entity types. There will be a maximum number of items + # returned based on the page_size field in the request. + # Corresponds to the JSON property `entityTypes` + # @return [Array] + attr_accessor :entity_types + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entity_types = args[:entity_types] if args.key?(:entity_types) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The response message for Intents.ListIntents. + class ListIntentsResponse + include Google::Apis::Core::Hashable + + # The list of agent intents. There will be a maximum number of items + # returned based on the page_size field in the request. + # Corresponds to the JSON property `intents` + # @return [Array] + attr_accessor :intents + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @intents = args[:intents] if args.key?(:intents) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The response message for SessionEntityTypes.ListSessionEntityTypes. + class ListSessionEntityTypesResponse + include Google::Apis::Core::Hashable + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The list of session entity types. There will be a maximum number of items + # returned based on the page_size field in the request. + # Corresponds to the JSON property `sessionEntityTypes` + # @return [Array] + attr_accessor :session_entity_types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class Operation + include Google::Apis::Core::Hashable + + # If the value is `false`, it means the operation is still in progress. + # If `true`, the operation is completed, and either `error` or `response` is + # available. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by + # [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error message, + # and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + # Corresponds to the JSON property `error` + # @return [Google::Apis::DialogflowV2beta1::Status] + attr_accessor :error + + # Service-specific metadata associated with the operation. It typically + # contains progress information and common metadata such as create time. + # Some services might not provide such metadata. Any method that returns a + # long-running operation should document the metadata type, if any. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # The server-assigned name, which is only unique within the same service that + # originally returns it. If you use the default HTTP mapping, the + # `name` should have the format of `operations/some/unique/name`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is + # `google.protobuf.Empty`. If the original method is standard + # `Get`/`Create`/`Update`, the response should be the resource. For other + # methods, the response should have the type `XxxResponse`, where `Xxx` + # is the original method name. For example, if the original method name + # is `TakeSnapshot()`, the inferred response type is + # `TakeSnapshotResponse`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @response = args[:response] if args.key?(:response) + end + end + + # Represents the contents of the original request that was passed to + # the `[Streaming]DetectIntent` call. + class OriginalDetectIntentRequest + include Google::Apis::Core::Hashable + + # Optional. This field is set to the value of `QueryParameters.payload` field + # passed in the request. + # Corresponds to the JSON property `payload` + # @return [Hash] + attr_accessor :payload + + # The source of this request, e.g., `google`, `facebook`, `slack`. It is set + # by Dialogflow-owned servers. Possible values of this field correspond to + # Intent.Message.Platform. + # Corresponds to the JSON property `source` + # @return [String] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @payload = args[:payload] if args.key?(:payload) + @source = args[:source] if args.key?(:source) + end + end + + # Represents the query input. It can contain either: + # 1. an audio config which + # instructs the speech recognizer how to process the speech audio, + # 2. a conversational query in the form of text, or + # 3. an event that specifies which intent to trigger. + class QueryInput + include Google::Apis::Core::Hashable + + # Instructs the speech recognizer how to process the audio content. + # Corresponds to the JSON property `audioConfig` + # @return [Google::Apis::DialogflowV2beta1::InputAudioConfig] + attr_accessor :audio_config + + # Events allow for matching intents by event name instead of the natural + # language input. For instance, input `` can trigger a personalized welcome response. + # The parameter `name` may be used by the agent in the response: + # `“Hello #welcome_event.name! What can I do for you today?”`. + # Corresponds to the JSON property `event` + # @return [Google::Apis::DialogflowV2beta1::EventInput] + attr_accessor :event + + # Represents the natural language text to be processed. + # Corresponds to the JSON property `text` + # @return [Google::Apis::DialogflowV2beta1::TextInput] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audio_config = args[:audio_config] if args.key?(:audio_config) + @event = args[:event] if args.key?(:event) + @text = args[:text] if args.key?(:text) + end + end + + # Represents the parameters of the conversational query. + class QueryParameters + include Google::Apis::Core::Hashable + + # Optional. The collection of contexts to be activated before this query is + # executed. + # Corresponds to the JSON property `contexts` + # @return [Array] + attr_accessor :contexts + + # An object representing a latitude/longitude pair. This is expressed as a pair + # of doubles representing degrees latitude and degrees longitude. Unless + # specified otherwise, this must conform to the + # WGS84 + # standard. Values must be within normalized ranges. + # Corresponds to the JSON property `geoLocation` + # @return [Google::Apis::DialogflowV2beta1::LatLng] + attr_accessor :geo_location + + # Optional. This field can be used to pass custom data into the webhook + # associated with the agent. Arbitrary JSON objects are supported. + # Corresponds to the JSON property `payload` + # @return [Hash] + attr_accessor :payload + + # Optional. Specifies whether to delete all contexts in the current session + # before the new ones are activated. + # Corresponds to the JSON property `resetContexts` + # @return [Boolean] + attr_accessor :reset_contexts + alias_method :reset_contexts?, :reset_contexts + + # Optional. The collection of session entity types to replace or extend + # developer entities with for this query only. The entity synonyms apply + # to all languages. + # Corresponds to the JSON property `sessionEntityTypes` + # @return [Array] + attr_accessor :session_entity_types + + # Optional. The time zone of this conversational query from the + # [time zone database](https://www.iana.org/time-zones), e.g., + # America/New_York, Europe/Paris. If not provided, the time zone specified in + # agent settings is used. + # Corresponds to the JSON property `timeZone` + # @return [String] + attr_accessor :time_zone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @contexts = args[:contexts] if args.key?(:contexts) + @geo_location = args[:geo_location] if args.key?(:geo_location) + @payload = args[:payload] if args.key?(:payload) + @reset_contexts = args[:reset_contexts] if args.key?(:reset_contexts) + @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types) + @time_zone = args[:time_zone] if args.key?(:time_zone) + end + end + + # Represents the result of conversational query or event processing. + class QueryResult + include Google::Apis::Core::Hashable + + # The action name from the matched intent. + # Corresponds to the JSON property `action` + # @return [String] + attr_accessor :action + + # This field is set to: + # - `false` if the matched intent has required parameters and not all of + # the required parameter values have been collected. + # - `true` if all required parameter values have been collected, or if the + # matched intent doesn't contain any required parameters. + # Corresponds to the JSON property `allRequiredParamsPresent` + # @return [Boolean] + attr_accessor :all_required_params_present + alias_method :all_required_params_present?, :all_required_params_present + + # The free-form diagnostic info. For example, this field + # could contain webhook call latency. + # Corresponds to the JSON property `diagnosticInfo` + # @return [Hash] + attr_accessor :diagnostic_info + + # The collection of rich messages to present to the user. + # Corresponds to the JSON property `fulfillmentMessages` + # @return [Array] + attr_accessor :fulfillment_messages + + # The text to be pronounced to the user or shown on the screen. + # Corresponds to the JSON property `fulfillmentText` + # @return [String] + attr_accessor :fulfillment_text + + # Represents an intent. + # Intents convert a number of user expressions or patterns into an action. An + # action is an extraction of a user command or sentence semantics. + # Corresponds to the JSON property `intent` + # @return [Google::Apis::DialogflowV2beta1::Intent] + attr_accessor :intent + + # The intent detection confidence. Values range from 0.0 + # (completely uncertain) to 1.0 (completely certain). + # Corresponds to the JSON property `intentDetectionConfidence` + # @return [Float] + attr_accessor :intent_detection_confidence + + # The language that was triggered during intent detection. + # See [Language Support](https://dialogflow.com/docs/reference/language) + # for a list of the currently supported language codes. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # The collection of output contexts. If applicable, + # `output_contexts.parameters` contains entries with name + # `.original` containing the original parameter values + # before the query. + # Corresponds to the JSON property `outputContexts` + # @return [Array] + attr_accessor :output_contexts + + # The collection of extracted parameters. + # Corresponds to the JSON property `parameters` + # @return [Hash] + attr_accessor :parameters + + # The original conversational query text: + # - If natural language text was provided as input, `query_text` contains + # a copy of the input. + # - If natural language speech audio was provided as input, `query_text` + # contains the speech recognition result. If speech recognizer produced + # multiple alternatives, a particular one is picked. + # - If an event was provided as input, `query_text` is not set. + # Corresponds to the JSON property `queryText` + # @return [String] + attr_accessor :query_text + + # The confidence estimate between 0.0 and 1.0. A higher number + # indicates an estimated greater likelihood that the recognized words are + # correct. The default of 0.0 is a sentinel value indicating that confidence + # was not set. This field is populated if natural speech audio was provided + # as input. + # Corresponds to the JSON property `speechRecognitionConfidence` + # @return [Float] + attr_accessor :speech_recognition_confidence + + # If the query was fulfilled by a webhook call, this field is set to the + # value of the `payload` field returned in the webhook response. + # Corresponds to the JSON property `webhookPayload` + # @return [Hash] + attr_accessor :webhook_payload + + # If the query was fulfilled by a webhook call, this field is set to the + # value of the `source` field returned in the webhook response. + # Corresponds to the JSON property `webhookSource` + # @return [String] + attr_accessor :webhook_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] if args.key?(:action) + @all_required_params_present = args[:all_required_params_present] if args.key?(:all_required_params_present) + @diagnostic_info = args[:diagnostic_info] if args.key?(:diagnostic_info) + @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages) + @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text) + @intent = args[:intent] if args.key?(:intent) + @intent_detection_confidence = args[:intent_detection_confidence] if args.key?(:intent_detection_confidence) + @language_code = args[:language_code] if args.key?(:language_code) + @output_contexts = args[:output_contexts] if args.key?(:output_contexts) + @parameters = args[:parameters] if args.key?(:parameters) + @query_text = args[:query_text] if args.key?(:query_text) + @speech_recognition_confidence = args[:speech_recognition_confidence] if args.key?(:speech_recognition_confidence) + @webhook_payload = args[:webhook_payload] if args.key?(:webhook_payload) + @webhook_source = args[:webhook_source] if args.key?(:webhook_source) + end + end + + # The request message for Agents.RestoreAgent. + class RestoreAgentRequest + include Google::Apis::Core::Hashable + + # The agent to restore. + # Corresponds to the JSON property `agentContent` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :agent_content + + # Warning: Restoring agents from a URI is not implemented yet. + # This feature is coming soon. + # The URI to a Google Cloud Storage file containing the agent to restore. + # Note: The URI must start with "gs://". + # Corresponds to the JSON property `agentUri` + # @return [String] + attr_accessor :agent_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agent_content = args[:agent_content] if args.key?(:agent_content) + @agent_uri = args[:agent_uri] if args.key?(:agent_uri) + end + end + + # The response message for Agents.SearchAgents. + class SearchAgentsResponse + include Google::Apis::Core::Hashable + + # The list of agents. There will be a maximum number of items returned based + # on the page_size field in the request. + # Corresponds to the JSON property `agents` + # @return [Array] + attr_accessor :agents + + # Token to retrieve the next page of results, or empty if there are no + # more results in the list. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agents = args[:agents] if args.key?(:agents) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Represents a session entity type. + # Extends or replaces a developer entity type at the user session level (we + # refer to the entity types defined at the agent level as "developer entity + # types"). + # Note: session entity types apply to all queries, regardless of the language. + class SessionEntityType + include Google::Apis::Core::Hashable + + # Required. The collection of entities associated with this session entity + # type. + # Corresponds to the JSON property `entities` + # @return [Array] + attr_accessor :entities + + # Required. Indicates whether the additional data should override or + # supplement the developer entity type definition. + # Corresponds to the JSON property `entityOverrideMode` + # @return [String] + attr_accessor :entity_override_mode + + # Required. The unique identifier of this session entity type. Format: + # `projects//agent/sessions//entityTypes/`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entities = args[:entities] if args.key?(:entities) + @entity_override_mode = args[:entity_override_mode] if args.key?(:entity_override_mode) + @name = args[:name] if args.key?(:name) + end + end + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by + # [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error message, + # and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + class Status + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # A developer-facing error message, which should be in English. Any + # user-facing error message should be localized and sent in the + # google.rpc.Status.details field, or localized by the client. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + + # Represents the natural language text to be processed. + class TextInput + include Google::Apis::Core::Hashable + + # Required. The language of this conversational query. See [Language + # Support](https://dialogflow.com/docs/languages) for a list of the + # currently supported language codes. Note that queries in the same session + # do not necessarily need to specify the same language. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Required. The UTF-8 encoded natural language text to be processed. + # Text length must not exceed 256 bytes. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @language_code = args[:language_code] if args.key?(:language_code) + @text = args[:text] if args.key?(:text) + end + end + + # The request message for Agents.TrainAgent. + class TrainAgentRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # The request message for a webhook call. + class WebhookRequest + include Google::Apis::Core::Hashable + + # Represents the contents of the original request that was passed to + # the `[Streaming]DetectIntent` call. + # Corresponds to the JSON property `originalDetectIntentRequest` + # @return [Google::Apis::DialogflowV2beta1::OriginalDetectIntentRequest] + attr_accessor :original_detect_intent_request + + # Represents the result of conversational query or event processing. + # Corresponds to the JSON property `queryResult` + # @return [Google::Apis::DialogflowV2beta1::QueryResult] + attr_accessor :query_result + + # The unique identifier of the response. Contains the same value as + # `[Streaming]DetectIntentResponse.response_id`. + # Corresponds to the JSON property `responseId` + # @return [String] + attr_accessor :response_id + + # The unique identifier of detectIntent request session. + # Can be used to identify end-user inside webhook implementation. + # Format: `projects//agent/sessions/`. + # Corresponds to the JSON property `session` + # @return [String] + attr_accessor :session + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @original_detect_intent_request = args[:original_detect_intent_request] if args.key?(:original_detect_intent_request) + @query_result = args[:query_result] if args.key?(:query_result) + @response_id = args[:response_id] if args.key?(:response_id) + @session = args[:session] if args.key?(:session) + end + end + + # The response message for a webhook call. + class WebhookResponse + include Google::Apis::Core::Hashable + + # Events allow for matching intents by event name instead of the natural + # language input. For instance, input `` can trigger a personalized welcome response. + # The parameter `name` may be used by the agent in the response: + # `“Hello #welcome_event.name! What can I do for you today?”`. + # Corresponds to the JSON property `followupEventInput` + # @return [Google::Apis::DialogflowV2beta1::EventInput] + attr_accessor :followup_event_input + + # Optional. The collection of rich messages to present to the user. This + # value is passed directly to `QueryResult.fulfillment_messages`. + # Corresponds to the JSON property `fulfillmentMessages` + # @return [Array] + attr_accessor :fulfillment_messages + + # Optional. The text to be shown on the screen. This value is passed directly + # to `QueryResult.fulfillment_text`. + # Corresponds to the JSON property `fulfillmentText` + # @return [String] + attr_accessor :fulfillment_text + + # Optional. The collection of output contexts. This value is passed directly + # to `QueryResult.output_contexts`. + # Corresponds to the JSON property `outputContexts` + # @return [Array] + attr_accessor :output_contexts + + # Optional. This value is passed directly to `QueryResult.webhook_payload`. + # Corresponds to the JSON property `payload` + # @return [Hash] + attr_accessor :payload + + # Optional. This value is passed directly to `QueryResult.webhook_source`. + # Corresponds to the JSON property `source` + # @return [String] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @followup_event_input = args[:followup_event_input] if args.key?(:followup_event_input) + @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages) + @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text) + @output_contexts = args[:output_contexts] if args.key?(:output_contexts) + @payload = args[:payload] if args.key?(:payload) + @source = args[:source] if args.key?(:source) + end + end + end + end +end diff --git a/generated/google/apis/dialogflow_v2beta1/representations.rb b/generated/google/apis/dialogflow_v2beta1/representations.rb new file mode 100644 index 000000000..5e6a5b034 --- /dev/null +++ b/generated/google/apis/dialogflow_v2beta1/representations.rb @@ -0,0 +1,1078 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DialogflowV2beta1 + + class Agent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchCreateEntitiesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchDeleteEntitiesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchDeleteEntityTypesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchDeleteIntentsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchUpdateEntitiesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchUpdateEntityTypesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchUpdateEntityTypesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchUpdateIntentsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BatchUpdateIntentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Context + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DetectIntentRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DetectIntentResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EntityType + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EntityTypeBatch + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EntityTypeEntity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EventInput + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExportAgentRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExportAgentResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImportAgentRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InputAudioConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Intent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentBatch + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentFollowupIntentInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageBasicCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageBasicCardButton + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageBasicCardButtonOpenUriAction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageCardButton + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageCarouselSelect + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageCarouselSelectItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageImage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageLinkOutSuggestion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageListSelect + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageListSelectItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageQuickReplies + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageSelectItemInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageSimpleResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageSimpleResponses + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageSuggestion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageSuggestions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentMessageText + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentParameter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentTrainingPhrase + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntentTrainingPhrasePart + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LatLng + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListContextsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListEntityTypesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListIntentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListSessionEntityTypesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OriginalDetectIntentRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class QueryInput + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class QueryParameters + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class QueryResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RestoreAgentRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SearchAgentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SessionEntityType + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TextInput + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TrainAgentRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class WebhookRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class WebhookResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Agent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :avatar_uri, as: 'avatarUri' + property :classification_threshold, as: 'classificationThreshold' + property :default_language_code, as: 'defaultLanguageCode' + property :description, as: 'description' + property :display_name, as: 'displayName' + property :enable_logging, as: 'enableLogging' + property :match_mode, as: 'matchMode' + property :parent, as: 'parent' + collection :supported_language_codes, as: 'supportedLanguageCodes' + property :time_zone, as: 'timeZone' + end + end + + class BatchCreateEntitiesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :entities, as: 'entities', class: Google::Apis::DialogflowV2beta1::EntityTypeEntity, decorator: Google::Apis::DialogflowV2beta1::EntityTypeEntity::Representation + + property :language_code, as: 'languageCode' + end + end + + class BatchDeleteEntitiesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :entity_values, as: 'entityValues' + property :language_code, as: 'languageCode' + end + end + + class BatchDeleteEntityTypesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :entity_type_names, as: 'entityTypeNames' + end + end + + class BatchDeleteIntentsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :intents, as: 'intents', class: Google::Apis::DialogflowV2beta1::Intent, decorator: Google::Apis::DialogflowV2beta1::Intent::Representation + + end + end + + class BatchUpdateEntitiesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :entities, as: 'entities', class: Google::Apis::DialogflowV2beta1::EntityTypeEntity, decorator: Google::Apis::DialogflowV2beta1::EntityTypeEntity::Representation + + property :language_code, as: 'languageCode' + property :update_mask, as: 'updateMask' + end + end + + class BatchUpdateEntityTypesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :entity_type_batch_inline, as: 'entityTypeBatchInline', class: Google::Apis::DialogflowV2beta1::EntityTypeBatch, decorator: Google::Apis::DialogflowV2beta1::EntityTypeBatch::Representation + + property :entity_type_batch_uri, as: 'entityTypeBatchUri' + property :language_code, as: 'languageCode' + property :update_mask, as: 'updateMask' + end + end + + class BatchUpdateEntityTypesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :entity_types, as: 'entityTypes', class: Google::Apis::DialogflowV2beta1::EntityType, decorator: Google::Apis::DialogflowV2beta1::EntityType::Representation + + end + end + + class BatchUpdateIntentsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :intent_batch_inline, as: 'intentBatchInline', class: Google::Apis::DialogflowV2beta1::IntentBatch, decorator: Google::Apis::DialogflowV2beta1::IntentBatch::Representation + + property :intent_batch_uri, as: 'intentBatchUri' + property :intent_view, as: 'intentView' + property :language_code, as: 'languageCode' + property :update_mask, as: 'updateMask' + end + end + + class BatchUpdateIntentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :intents, as: 'intents', class: Google::Apis::DialogflowV2beta1::Intent, decorator: Google::Apis::DialogflowV2beta1::Intent::Representation + + end + end + + class Context + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :lifespan_count, as: 'lifespanCount' + property :name, as: 'name' + hash :parameters, as: 'parameters' + end + end + + class DetectIntentRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :input_audio, :base64 => true, as: 'inputAudio' + property :query_input, as: 'queryInput', class: Google::Apis::DialogflowV2beta1::QueryInput, decorator: Google::Apis::DialogflowV2beta1::QueryInput::Representation + + property :query_params, as: 'queryParams', class: Google::Apis::DialogflowV2beta1::QueryParameters, decorator: Google::Apis::DialogflowV2beta1::QueryParameters::Representation + + end + end + + class DetectIntentResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :query_result, as: 'queryResult', class: Google::Apis::DialogflowV2beta1::QueryResult, decorator: Google::Apis::DialogflowV2beta1::QueryResult::Representation + + property :response_id, as: 'responseId' + property :webhook_status, as: 'webhookStatus', class: Google::Apis::DialogflowV2beta1::Status, decorator: Google::Apis::DialogflowV2beta1::Status::Representation + + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class EntityType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :auto_expansion_mode, as: 'autoExpansionMode' + property :display_name, as: 'displayName' + collection :entities, as: 'entities', class: Google::Apis::DialogflowV2beta1::EntityTypeEntity, decorator: Google::Apis::DialogflowV2beta1::EntityTypeEntity::Representation + + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class EntityTypeBatch + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :entity_types, as: 'entityTypes', class: Google::Apis::DialogflowV2beta1::EntityType, decorator: Google::Apis::DialogflowV2beta1::EntityType::Representation + + end + end + + class EntityTypeEntity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :synonyms, as: 'synonyms' + property :value, as: 'value' + end + end + + class EventInput + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :language_code, as: 'languageCode' + property :name, as: 'name' + hash :parameters, as: 'parameters' + end + end + + class ExportAgentRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :agent_uri, as: 'agentUri' + end + end + + class ExportAgentResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :agent_content, :base64 => true, as: 'agentContent' + property :agent_uri, as: 'agentUri' + end + end + + class ImportAgentRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :agent_content, :base64 => true, as: 'agentContent' + property :agent_uri, as: 'agentUri' + end + end + + class InputAudioConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :audio_encoding, as: 'audioEncoding' + property :language_code, as: 'languageCode' + collection :phrase_hints, as: 'phraseHints' + property :sample_rate_hertz, as: 'sampleRateHertz' + end + end + + class Intent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action' + collection :default_response_platforms, as: 'defaultResponsePlatforms' + property :display_name, as: 'displayName' + collection :events, as: 'events' + collection :followup_intent_info, as: 'followupIntentInfo', class: Google::Apis::DialogflowV2beta1::IntentFollowupIntentInfo, decorator: Google::Apis::DialogflowV2beta1::IntentFollowupIntentInfo::Representation + + collection :input_context_names, as: 'inputContextNames' + property :is_fallback, as: 'isFallback' + collection :messages, as: 'messages', class: Google::Apis::DialogflowV2beta1::IntentMessage, decorator: Google::Apis::DialogflowV2beta1::IntentMessage::Representation + + property :ml_enabled, as: 'mlEnabled' + property :name, as: 'name' + collection :output_contexts, as: 'outputContexts', class: Google::Apis::DialogflowV2beta1::Context, decorator: Google::Apis::DialogflowV2beta1::Context::Representation + + collection :parameters, as: 'parameters', class: Google::Apis::DialogflowV2beta1::IntentParameter, decorator: Google::Apis::DialogflowV2beta1::IntentParameter::Representation + + property :parent_followup_intent_name, as: 'parentFollowupIntentName' + property :priority, as: 'priority' + property :reset_contexts, as: 'resetContexts' + property :root_followup_intent_name, as: 'rootFollowupIntentName' + collection :training_phrases, as: 'trainingPhrases', class: Google::Apis::DialogflowV2beta1::IntentTrainingPhrase, decorator: Google::Apis::DialogflowV2beta1::IntentTrainingPhrase::Representation + + property :webhook_state, as: 'webhookState' + end + end + + class IntentBatch + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :intents, as: 'intents', class: Google::Apis::DialogflowV2beta1::Intent, decorator: Google::Apis::DialogflowV2beta1::Intent::Representation + + end + end + + class IntentFollowupIntentInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :followup_intent_name, as: 'followupIntentName' + property :parent_followup_intent_name, as: 'parentFollowupIntentName' + end + end + + class IntentMessage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :basic_card, as: 'basicCard', class: Google::Apis::DialogflowV2beta1::IntentMessageBasicCard, decorator: Google::Apis::DialogflowV2beta1::IntentMessageBasicCard::Representation + + property :card, as: 'card', class: Google::Apis::DialogflowV2beta1::IntentMessageCard, decorator: Google::Apis::DialogflowV2beta1::IntentMessageCard::Representation + + property :carousel_select, as: 'carouselSelect', class: Google::Apis::DialogflowV2beta1::IntentMessageCarouselSelect, decorator: Google::Apis::DialogflowV2beta1::IntentMessageCarouselSelect::Representation + + property :image, as: 'image', class: Google::Apis::DialogflowV2beta1::IntentMessageImage, decorator: Google::Apis::DialogflowV2beta1::IntentMessageImage::Representation + + property :link_out_suggestion, as: 'linkOutSuggestion', class: Google::Apis::DialogflowV2beta1::IntentMessageLinkOutSuggestion, decorator: Google::Apis::DialogflowV2beta1::IntentMessageLinkOutSuggestion::Representation + + property :list_select, as: 'listSelect', class: Google::Apis::DialogflowV2beta1::IntentMessageListSelect, decorator: Google::Apis::DialogflowV2beta1::IntentMessageListSelect::Representation + + hash :payload, as: 'payload' + property :platform, as: 'platform' + property :quick_replies, as: 'quickReplies', class: Google::Apis::DialogflowV2beta1::IntentMessageQuickReplies, decorator: Google::Apis::DialogflowV2beta1::IntentMessageQuickReplies::Representation + + property :simple_responses, as: 'simpleResponses', class: Google::Apis::DialogflowV2beta1::IntentMessageSimpleResponses, decorator: Google::Apis::DialogflowV2beta1::IntentMessageSimpleResponses::Representation + + property :suggestions, as: 'suggestions', class: Google::Apis::DialogflowV2beta1::IntentMessageSuggestions, decorator: Google::Apis::DialogflowV2beta1::IntentMessageSuggestions::Representation + + property :text, as: 'text', class: Google::Apis::DialogflowV2beta1::IntentMessageText, decorator: Google::Apis::DialogflowV2beta1::IntentMessageText::Representation + + end + end + + class IntentMessageBasicCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :buttons, as: 'buttons', class: Google::Apis::DialogflowV2beta1::IntentMessageBasicCardButton, decorator: Google::Apis::DialogflowV2beta1::IntentMessageBasicCardButton::Representation + + property :formatted_text, as: 'formattedText' + property :image, as: 'image', class: Google::Apis::DialogflowV2beta1::IntentMessageImage, decorator: Google::Apis::DialogflowV2beta1::IntentMessageImage::Representation + + property :subtitle, as: 'subtitle' + property :title, as: 'title' + end + end + + class IntentMessageBasicCardButton + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :open_uri_action, as: 'openUriAction', class: Google::Apis::DialogflowV2beta1::IntentMessageBasicCardButtonOpenUriAction, decorator: Google::Apis::DialogflowV2beta1::IntentMessageBasicCardButtonOpenUriAction::Representation + + property :title, as: 'title' + end + end + + class IntentMessageBasicCardButtonOpenUriAction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :uri, as: 'uri' + end + end + + class IntentMessageCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :buttons, as: 'buttons', class: Google::Apis::DialogflowV2beta1::IntentMessageCardButton, decorator: Google::Apis::DialogflowV2beta1::IntentMessageCardButton::Representation + + property :image_uri, as: 'imageUri' + property :subtitle, as: 'subtitle' + property :title, as: 'title' + end + end + + class IntentMessageCardButton + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :postback, as: 'postback' + property :text, as: 'text' + end + end + + class IntentMessageCarouselSelect + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :items, as: 'items', class: Google::Apis::DialogflowV2beta1::IntentMessageCarouselSelectItem, decorator: Google::Apis::DialogflowV2beta1::IntentMessageCarouselSelectItem::Representation + + end + end + + class IntentMessageCarouselSelectItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :image, as: 'image', class: Google::Apis::DialogflowV2beta1::IntentMessageImage, decorator: Google::Apis::DialogflowV2beta1::IntentMessageImage::Representation + + property :info, as: 'info', class: Google::Apis::DialogflowV2beta1::IntentMessageSelectItemInfo, decorator: Google::Apis::DialogflowV2beta1::IntentMessageSelectItemInfo::Representation + + property :title, as: 'title' + end + end + + class IntentMessageImage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image_uri, as: 'imageUri' + end + end + + class IntentMessageLinkOutSuggestion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :destination_name, as: 'destinationName' + property :uri, as: 'uri' + end + end + + class IntentMessageListSelect + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :items, as: 'items', class: Google::Apis::DialogflowV2beta1::IntentMessageListSelectItem, decorator: Google::Apis::DialogflowV2beta1::IntentMessageListSelectItem::Representation + + property :title, as: 'title' + end + end + + class IntentMessageListSelectItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :image, as: 'image', class: Google::Apis::DialogflowV2beta1::IntentMessageImage, decorator: Google::Apis::DialogflowV2beta1::IntentMessageImage::Representation + + property :info, as: 'info', class: Google::Apis::DialogflowV2beta1::IntentMessageSelectItemInfo, decorator: Google::Apis::DialogflowV2beta1::IntentMessageSelectItemInfo::Representation + + property :title, as: 'title' + end + end + + class IntentMessageQuickReplies + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :quick_replies, as: 'quickReplies' + property :title, as: 'title' + end + end + + class IntentMessageSelectItemInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + collection :synonyms, as: 'synonyms' + end + end + + class IntentMessageSimpleResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_text, as: 'displayText' + property :ssml, as: 'ssml' + property :text_to_speech, as: 'textToSpeech' + end + end + + class IntentMessageSimpleResponses + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :simple_responses, as: 'simpleResponses', class: Google::Apis::DialogflowV2beta1::IntentMessageSimpleResponse, decorator: Google::Apis::DialogflowV2beta1::IntentMessageSimpleResponse::Representation + + end + end + + class IntentMessageSuggestion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :title, as: 'title' + end + end + + class IntentMessageSuggestions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :suggestions, as: 'suggestions', class: Google::Apis::DialogflowV2beta1::IntentMessageSuggestion, decorator: Google::Apis::DialogflowV2beta1::IntentMessageSuggestion::Representation + + end + end + + class IntentMessageText + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :text, as: 'text' + end + end + + class IntentParameter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :default_value, as: 'defaultValue' + property :display_name, as: 'displayName' + property :entity_type_display_name, as: 'entityTypeDisplayName' + property :is_list, as: 'isList' + property :mandatory, as: 'mandatory' + property :name, as: 'name' + collection :prompts, as: 'prompts' + property :value, as: 'value' + end + end + + class IntentTrainingPhrase + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + collection :parts, as: 'parts', class: Google::Apis::DialogflowV2beta1::IntentTrainingPhrasePart, decorator: Google::Apis::DialogflowV2beta1::IntentTrainingPhrasePart::Representation + + property :times_added_count, as: 'timesAddedCount' + property :type, as: 'type' + end + end + + class IntentTrainingPhrasePart + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :alias, as: 'alias' + property :entity_type, as: 'entityType' + property :text, as: 'text' + property :user_defined, as: 'userDefined' + end + end + + class LatLng + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :latitude, as: 'latitude' + property :longitude, as: 'longitude' + end + end + + class ListContextsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :contexts, as: 'contexts', class: Google::Apis::DialogflowV2beta1::Context, decorator: Google::Apis::DialogflowV2beta1::Context::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListEntityTypesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :entity_types, as: 'entityTypes', class: Google::Apis::DialogflowV2beta1::EntityType, decorator: Google::Apis::DialogflowV2beta1::EntityType::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListIntentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :intents, as: 'intents', class: Google::Apis::DialogflowV2beta1::Intent, decorator: Google::Apis::DialogflowV2beta1::Intent::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListSessionEntityTypesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :session_entity_types, as: 'sessionEntityTypes', class: Google::Apis::DialogflowV2beta1::SessionEntityType, decorator: Google::Apis::DialogflowV2beta1::SessionEntityType::Representation + + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::DialogflowV2beta1::Status, decorator: Google::Apis::DialogflowV2beta1::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class OriginalDetectIntentRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :payload, as: 'payload' + property :source, as: 'source' + end + end + + class QueryInput + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :audio_config, as: 'audioConfig', class: Google::Apis::DialogflowV2beta1::InputAudioConfig, decorator: Google::Apis::DialogflowV2beta1::InputAudioConfig::Representation + + property :event, as: 'event', class: Google::Apis::DialogflowV2beta1::EventInput, decorator: Google::Apis::DialogflowV2beta1::EventInput::Representation + + property :text, as: 'text', class: Google::Apis::DialogflowV2beta1::TextInput, decorator: Google::Apis::DialogflowV2beta1::TextInput::Representation + + end + end + + class QueryParameters + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :contexts, as: 'contexts', class: Google::Apis::DialogflowV2beta1::Context, decorator: Google::Apis::DialogflowV2beta1::Context::Representation + + property :geo_location, as: 'geoLocation', class: Google::Apis::DialogflowV2beta1::LatLng, decorator: Google::Apis::DialogflowV2beta1::LatLng::Representation + + hash :payload, as: 'payload' + property :reset_contexts, as: 'resetContexts' + collection :session_entity_types, as: 'sessionEntityTypes', class: Google::Apis::DialogflowV2beta1::SessionEntityType, decorator: Google::Apis::DialogflowV2beta1::SessionEntityType::Representation + + property :time_zone, as: 'timeZone' + end + end + + class QueryResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action' + property :all_required_params_present, as: 'allRequiredParamsPresent' + hash :diagnostic_info, as: 'diagnosticInfo' + collection :fulfillment_messages, as: 'fulfillmentMessages', class: Google::Apis::DialogflowV2beta1::IntentMessage, decorator: Google::Apis::DialogflowV2beta1::IntentMessage::Representation + + property :fulfillment_text, as: 'fulfillmentText' + property :intent, as: 'intent', class: Google::Apis::DialogflowV2beta1::Intent, decorator: Google::Apis::DialogflowV2beta1::Intent::Representation + + property :intent_detection_confidence, as: 'intentDetectionConfidence' + property :language_code, as: 'languageCode' + collection :output_contexts, as: 'outputContexts', class: Google::Apis::DialogflowV2beta1::Context, decorator: Google::Apis::DialogflowV2beta1::Context::Representation + + hash :parameters, as: 'parameters' + property :query_text, as: 'queryText' + property :speech_recognition_confidence, as: 'speechRecognitionConfidence' + hash :webhook_payload, as: 'webhookPayload' + property :webhook_source, as: 'webhookSource' + end + end + + class RestoreAgentRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :agent_content, :base64 => true, as: 'agentContent' + property :agent_uri, as: 'agentUri' + end + end + + class SearchAgentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :agents, as: 'agents', class: Google::Apis::DialogflowV2beta1::Agent, decorator: Google::Apis::DialogflowV2beta1::Agent::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class SessionEntityType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :entities, as: 'entities', class: Google::Apis::DialogflowV2beta1::EntityTypeEntity, decorator: Google::Apis::DialogflowV2beta1::EntityTypeEntity::Representation + + property :entity_override_mode, as: 'entityOverrideMode' + property :name, as: 'name' + end + end + + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + + class TextInput + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :language_code, as: 'languageCode' + property :text, as: 'text' + end + end + + class TrainAgentRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class WebhookRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :original_detect_intent_request, as: 'originalDetectIntentRequest', class: Google::Apis::DialogflowV2beta1::OriginalDetectIntentRequest, decorator: Google::Apis::DialogflowV2beta1::OriginalDetectIntentRequest::Representation + + property :query_result, as: 'queryResult', class: Google::Apis::DialogflowV2beta1::QueryResult, decorator: Google::Apis::DialogflowV2beta1::QueryResult::Representation + + property :response_id, as: 'responseId' + property :session, as: 'session' + end + end + + class WebhookResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :followup_event_input, as: 'followupEventInput', class: Google::Apis::DialogflowV2beta1::EventInput, decorator: Google::Apis::DialogflowV2beta1::EventInput::Representation + + collection :fulfillment_messages, as: 'fulfillmentMessages', class: Google::Apis::DialogflowV2beta1::IntentMessage, decorator: Google::Apis::DialogflowV2beta1::IntentMessage::Representation + + property :fulfillment_text, as: 'fulfillmentText' + collection :output_contexts, as: 'outputContexts', class: Google::Apis::DialogflowV2beta1::Context, decorator: Google::Apis::DialogflowV2beta1::Context::Representation + + hash :payload, as: 'payload' + property :source, as: 'source' + end + end + end + end +end diff --git a/generated/google/apis/dialogflow_v2beta1/service.rb b/generated/google/apis/dialogflow_v2beta1/service.rb new file mode 100644 index 000000000..ca74e6950 --- /dev/null +++ b/generated/google/apis/dialogflow_v2beta1/service.rb @@ -0,0 +1,1398 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DialogflowV2beta1 + # Dialogflow API + # + # An end-to-end development suite for conversational interfaces (e.g., chatbots, + # voice-powered apps and devices). + # + # @example + # require 'google/apis/dialogflow_v2beta1' + # + # Dialogflow = Google::Apis::DialogflowV2beta1 # Alias the module + # service = Dialogflow::DialogflowService.new + # + # @see https://cloud.google.com/dialogflow-enterprise/ + class DialogflowService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + attr_accessor :quota_user + + def initialize + super('https://dialogflow.googleapis.com/', '') + @batch_path = 'batch' + end + + # Retrieves the specified agent. + # @param [String] parent + # Required. The project that the agent to fetch is associated with. + # Format: `projects/`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Agent] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Agent] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_agent(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+parent}/agent', options) + command.response_representation = Google::Apis::DialogflowV2beta1::Agent::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Agent + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Exports the specified agent to a ZIP file. + # Operation + # @param [String] parent + # Required. The project that the agent to export is associated with. + # Format: `projects/`. + # @param [Google::Apis::DialogflowV2beta1::ExportAgentRequest] export_agent_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def export_agent(parent, export_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/agent:export', options) + command.request_representation = Google::Apis::DialogflowV2beta1::ExportAgentRequest::Representation + command.request_object = export_agent_request_object + command.response_representation = Google::Apis::DialogflowV2beta1::Operation::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Imports the specified agent from a ZIP file. + # Uploads new intents and entity types without deleting the existing ones. + # Intents and entity types with the same name are replaced with the new + # versions from ImportAgentRequest. + # Operation + # @param [String] parent + # Required. The project that the agent to import is associated with. + # Format: `projects/`. + # @param [Google::Apis::DialogflowV2beta1::ImportAgentRequest] import_agent_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def import_agent(parent, import_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/agent:import', options) + command.request_representation = Google::Apis::DialogflowV2beta1::ImportAgentRequest::Representation + command.request_object = import_agent_request_object + command.response_representation = Google::Apis::DialogflowV2beta1::Operation::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Restores the specified agent from a ZIP file. + # Replaces the current agent version with a new one. All the intents and + # entity types in the older version are deleted. + # Operation + # @param [String] parent + # Required. The project that the agent to restore is associated with. + # Format: `projects/`. + # @param [Google::Apis::DialogflowV2beta1::RestoreAgentRequest] restore_agent_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def restore_agent(parent, restore_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/agent:restore', options) + command.request_representation = Google::Apis::DialogflowV2beta1::RestoreAgentRequest::Representation + command.request_object = restore_agent_request_object + command.response_representation = Google::Apis::DialogflowV2beta1::Operation::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns the list of agents. + # Since there is at most one conversational agent per project, this method is + # useful primarily for listing all agents across projects the caller has + # access to. One can achieve that with a wildcard project collection id "-". + # Refer to [List + # Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub- + # collections). + # @param [String] parent + # Required. The project to list agents from. + # Format: `projects/`. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return in a single page. By + # default 100 and at most 1000. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous list request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::SearchAgentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::SearchAgentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_project_agents(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+parent}/agent:search', options) + command.response_representation = Google::Apis::DialogflowV2beta1::SearchAgentsResponse::Representation + command.response_class = Google::Apis::DialogflowV2beta1::SearchAgentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Trains the specified agent. + # Operation + # @param [String] parent + # Required. The project that the agent to train is associated with. + # Format: `projects/`. + # @param [Google::Apis::DialogflowV2beta1::TrainAgentRequest] train_agent_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def train_agent(parent, train_agent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/agent:train', options) + command.request_representation = Google::Apis::DialogflowV2beta1::TrainAgentRequest::Representation + command.request_object = train_agent_request_object + command.response_representation = Google::Apis::DialogflowV2beta1::Operation::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes entity types in the specified agent. + # Operation + # @param [String] parent + # Required. The name of the agent to delete all entities types for. Format: + # `projects//agent`. + # @param [Google::Apis::DialogflowV2beta1::BatchDeleteEntityTypesRequest] batch_delete_entity_types_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def batch_delete_entity_types(parent, batch_delete_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/entityTypes:batchDelete', options) + command.request_representation = Google::Apis::DialogflowV2beta1::BatchDeleteEntityTypesRequest::Representation + command.request_object = batch_delete_entity_types_request_object + command.response_representation = Google::Apis::DialogflowV2beta1::Operation::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates/Creates multiple entity types in the specified agent. + # Operation + # @param [String] parent + # Required. The name of the agent to update or create entity types in. + # Format: `projects//agent`. + # @param [Google::Apis::DialogflowV2beta1::BatchUpdateEntityTypesRequest] batch_update_entity_types_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def batch_update_entity_types(parent, batch_update_entity_types_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/entityTypes:batchUpdate', options) + command.request_representation = Google::Apis::DialogflowV2beta1::BatchUpdateEntityTypesRequest::Representation + command.request_object = batch_update_entity_types_request_object + command.response_representation = Google::Apis::DialogflowV2beta1::Operation::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates an entity type in the specified agent. + # @param [String] parent + # Required. The agent to create a entity type for. + # Format: `projects//agent`. + # @param [Google::Apis::DialogflowV2beta1::EntityType] entity_type_object + # @param [String] language_code + # Optional. The language of entity synonyms defined in `entity_type`. If not + # specified, the agent's default language is used. + # [More than a dozen + # languages](https://dialogflow.com/docs/reference/language) are supported. + # Note: languages must be enabled in the agent, before they can be used. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::EntityType] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::EntityType] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_agent_entity_type(parent, entity_type_object = nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/entityTypes', options) + command.request_representation = Google::Apis::DialogflowV2beta1::EntityType::Representation + command.request_object = entity_type_object + command.response_representation = Google::Apis::DialogflowV2beta1::EntityType::Representation + command.response_class = Google::Apis::DialogflowV2beta1::EntityType + command.params['parent'] = parent unless parent.nil? + command.query['languageCode'] = language_code unless language_code.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified entity type. + # @param [String] name + # Required. The name of the entity type to delete. + # Format: `projects//agent/entityTypes/`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_agent_entity_type(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v2beta1/{+name}', options) + command.response_representation = Google::Apis::DialogflowV2beta1::Empty::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the specified entity type. + # @param [String] name + # Required. The name of the entity type. + # Format: `projects//agent/entityTypes/`. + # @param [String] language_code + # Optional. The language to retrieve entity synonyms for. If not specified, + # the agent's default language is used. + # [More than a dozen + # languages](https://dialogflow.com/docs/reference/language) are supported. + # Note: languages must be enabled in the agent, before they can be used. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::EntityType] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::EntityType] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_agent_entity_type(name, language_code: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+name}', options) + command.response_representation = Google::Apis::DialogflowV2beta1::EntityType::Representation + command.response_class = Google::Apis::DialogflowV2beta1::EntityType + command.params['name'] = name unless name.nil? + command.query['languageCode'] = language_code unless language_code.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns the list of all entity types in the specified agent. + # @param [String] parent + # Required. The agent to list all entity types from. + # Format: `projects//agent`. + # @param [String] language_code + # Optional. The language to list entity synonyms for. If not specified, + # the agent's default language is used. + # [More than a dozen + # languages](https://dialogflow.com/docs/reference/language) are supported. + # Note: languages must be enabled in the agent, before they can be used. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return in a single page. By + # default 100 and at most 1000. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous list request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::ListEntityTypesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::ListEntityTypesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_agent_entity_types(parent, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+parent}/entityTypes', options) + command.response_representation = Google::Apis::DialogflowV2beta1::ListEntityTypesResponse::Representation + command.response_class = Google::Apis::DialogflowV2beta1::ListEntityTypesResponse + command.params['parent'] = parent unless parent.nil? + command.query['languageCode'] = language_code unless language_code.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the specified entity type. + # @param [String] name + # Required for all methods except `create` (`create` populates the name + # automatically. + # The unique identifier of the entity type. Format: + # `projects//agent/entityTypes/`. + # @param [Google::Apis::DialogflowV2beta1::EntityType] entity_type_object + # @param [String] language_code + # Optional. The language of entity synonyms defined in `entity_type`. If not + # specified, the agent's default language is used. + # [More than a dozen + # languages](https://dialogflow.com/docs/reference/language) are supported. + # Note: languages must be enabled in the agent, before they can be used. + # @param [String] update_mask + # Optional. The mask to control which fields get updated. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::EntityType] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::EntityType] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_agent_entity_type(name, entity_type_object = nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v2beta1/{+name}', options) + command.request_representation = Google::Apis::DialogflowV2beta1::EntityType::Representation + command.request_object = entity_type_object + command.response_representation = Google::Apis::DialogflowV2beta1::EntityType::Representation + command.response_class = Google::Apis::DialogflowV2beta1::EntityType + command.params['name'] = name unless name.nil? + command.query['languageCode'] = language_code unless language_code.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates multiple new entities in the specified entity type (extends the + # existing collection of entries). + # Operation + # @param [String] parent + # Required. The name of the entity type to create entities in. Format: + # `projects//agent/entityTypes/`. + # @param [Google::Apis::DialogflowV2beta1::BatchCreateEntitiesRequest] batch_create_entities_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def batch_entity_create_entities(parent, batch_create_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/entities:batchCreate', options) + command.request_representation = Google::Apis::DialogflowV2beta1::BatchCreateEntitiesRequest::Representation + command.request_object = batch_create_entities_request_object + command.response_representation = Google::Apis::DialogflowV2beta1::Operation::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes entities in the specified entity type. + # Operation + # @param [String] parent + # Required. The name of the entity type to delete entries for. Format: + # `projects//agent/entityTypes/`. + # @param [Google::Apis::DialogflowV2beta1::BatchDeleteEntitiesRequest] batch_delete_entities_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def batch_entity_delete_entities(parent, batch_delete_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/entities:batchDelete', options) + command.request_representation = Google::Apis::DialogflowV2beta1::BatchDeleteEntitiesRequest::Representation + command.request_object = batch_delete_entities_request_object + command.response_representation = Google::Apis::DialogflowV2beta1::Operation::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates entities in the specified entity type (replaces the existing + # collection of entries). + # Operation + # @param [String] parent + # Required. The name of the entity type to update the entities in. Format: + # `projects//agent/entityTypes/`. + # @param [Google::Apis::DialogflowV2beta1::BatchUpdateEntitiesRequest] batch_update_entities_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def batch_entity_update_entities(parent, batch_update_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/entities:batchUpdate', options) + command.request_representation = Google::Apis::DialogflowV2beta1::BatchUpdateEntitiesRequest::Representation + command.request_object = batch_update_entities_request_object + command.response_representation = Google::Apis::DialogflowV2beta1::Operation::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes intents in the specified agent. + # Operation + # @param [String] parent + # Required. The name of the agent to delete all entities types for. Format: + # `projects//agent`. + # @param [Google::Apis::DialogflowV2beta1::BatchDeleteIntentsRequest] batch_delete_intents_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def batch_delete_intents(parent, batch_delete_intents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/intents:batchDelete', options) + command.request_representation = Google::Apis::DialogflowV2beta1::BatchDeleteIntentsRequest::Representation + command.request_object = batch_delete_intents_request_object + command.response_representation = Google::Apis::DialogflowV2beta1::Operation::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates/Creates multiple intents in the specified agent. + # Operation + # @param [String] parent + # Required. The name of the agent to update or create intents in. + # Format: `projects//agent`. + # @param [Google::Apis::DialogflowV2beta1::BatchUpdateIntentsRequest] batch_update_intents_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def batch_update_intents(parent, batch_update_intents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/intents:batchUpdate', options) + command.request_representation = Google::Apis::DialogflowV2beta1::BatchUpdateIntentsRequest::Representation + command.request_object = batch_update_intents_request_object + command.response_representation = Google::Apis::DialogflowV2beta1::Operation::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates an intent in the specified agent. + # @param [String] parent + # Required. The agent to create a intent for. + # Format: `projects//agent`. + # @param [Google::Apis::DialogflowV2beta1::Intent] intent_object + # @param [String] intent_view + # Optional. The resource view to apply to the returned intent. + # @param [String] language_code + # Optional. The language of training phrases, parameters and rich messages + # defined in `intent`. If not specified, the agent's default language is + # used. [More than a dozen + # languages](https://dialogflow.com/docs/reference/language) are supported. + # Note: languages must be enabled in the agent, before they can be used. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Intent] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Intent] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_agent_intent(parent, intent_object = nil, intent_view: nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/intents', options) + command.request_representation = Google::Apis::DialogflowV2beta1::Intent::Representation + command.request_object = intent_object + command.response_representation = Google::Apis::DialogflowV2beta1::Intent::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Intent + command.params['parent'] = parent unless parent.nil? + command.query['intentView'] = intent_view unless intent_view.nil? + command.query['languageCode'] = language_code unless language_code.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified intent. + # @param [String] name + # Required. The name of the intent to delete. + # Format: `projects//agent/intents/`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_agent_intent(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v2beta1/{+name}', options) + command.response_representation = Google::Apis::DialogflowV2beta1::Empty::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the specified intent. + # @param [String] name + # Required. The name of the intent. + # Format: `projects//agent/intents/`. + # @param [String] intent_view + # Optional. The resource view to apply to the returned intent. + # @param [String] language_code + # Optional. The language to retrieve training phrases, parameters and rich + # messages for. If not specified, the agent's default language is used. + # [More than a dozen + # languages](https://dialogflow.com/docs/reference/language) are supported. + # Note: languages must be enabled in the agent, before they can be used. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Intent] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Intent] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_agent_intent(name, intent_view: nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+name}', options) + command.response_representation = Google::Apis::DialogflowV2beta1::Intent::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Intent + command.params['name'] = name unless name.nil? + command.query['intentView'] = intent_view unless intent_view.nil? + command.query['languageCode'] = language_code unless language_code.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns the list of all intents in the specified agent. + # @param [String] parent + # Required. The agent to list all intents from. + # Format: `projects//agent`. + # @param [String] intent_view + # Optional. The resource view to apply to the returned intent. + # @param [String] language_code + # Optional. The language to list training phrases, parameters and rich + # messages for. If not specified, the agent's default language is used. + # [More than a dozen + # languages](https://dialogflow.com/docs/reference/language) are supported. + # Note: languages must be enabled in the agent before they can be used. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return in a single page. By + # default 100 and at most 1000. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous list request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::ListIntentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::ListIntentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_agent_intents(parent, intent_view: nil, language_code: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+parent}/intents', options) + command.response_representation = Google::Apis::DialogflowV2beta1::ListIntentsResponse::Representation + command.response_class = Google::Apis::DialogflowV2beta1::ListIntentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['intentView'] = intent_view unless intent_view.nil? + command.query['languageCode'] = language_code unless language_code.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the specified intent. + # @param [String] name + # Required for all methods except `create` (`create` populates the name + # automatically. + # The unique identifier of this intent. + # Format: `projects//agent/intents/`. + # @param [Google::Apis::DialogflowV2beta1::Intent] intent_object + # @param [String] intent_view + # Optional. The resource view to apply to the returned intent. + # @param [String] language_code + # Optional. The language of training phrases, parameters and rich messages + # defined in `intent`. If not specified, the agent's default language is + # used. [More than a dozen + # languages](https://dialogflow.com/docs/reference/language) are supported. + # Note: languages must be enabled in the agent, before they can be used. + # @param [String] update_mask + # Optional. The mask to control which fields get updated. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Intent] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Intent] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_agent_intent(name, intent_object = nil, intent_view: nil, language_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v2beta1/{+name}', options) + command.request_representation = Google::Apis::DialogflowV2beta1::Intent::Representation + command.request_object = intent_object + command.response_representation = Google::Apis::DialogflowV2beta1::Intent::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Intent + command.params['name'] = name unless name.nil? + command.query['intentView'] = intent_view unless intent_view.nil? + command.query['languageCode'] = language_code unless language_code.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes all active contexts in the specified session. + # @param [String] parent + # Required. The name of the session to delete all contexts from. Format: + # `projects//agent/sessions/`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_agent_session_contexts(parent, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v2beta1/{+parent}/contexts', options) + command.response_representation = Google::Apis::DialogflowV2beta1::Empty::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Empty + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Processes a natural language query and returns structured, actionable data + # as a result. This method is not idempotent, because it may cause contexts + # and session entity types to be updated, which in turn might affect + # results of future queries. + # @param [String] session + # Required. The name of the session this query is sent to. Format: + # `projects//agent/sessions/`. + # It's up to the API caller to choose an appropriate session ID. It can be + # a random number or some type of user identifier (preferably hashed). + # The length of the session ID must not exceed 36 bytes. + # @param [Google::Apis::DialogflowV2beta1::DetectIntentRequest] detect_intent_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::DetectIntentResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::DetectIntentResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def detect_session_intent(session, detect_intent_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+session}:detectIntent', options) + command.request_representation = Google::Apis::DialogflowV2beta1::DetectIntentRequest::Representation + command.request_object = detect_intent_request_object + command.response_representation = Google::Apis::DialogflowV2beta1::DetectIntentResponse::Representation + command.response_class = Google::Apis::DialogflowV2beta1::DetectIntentResponse + command.params['session'] = session unless session.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a context. + # @param [String] parent + # Required. The session to create a context for. + # Format: `projects//agent/sessions/`. + # @param [Google::Apis::DialogflowV2beta1::Context] context_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Context] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Context] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_agent_session_context(parent, context_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/contexts', options) + command.request_representation = Google::Apis::DialogflowV2beta1::Context::Representation + command.request_object = context_object + command.response_representation = Google::Apis::DialogflowV2beta1::Context::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Context + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified context. + # @param [String] name + # Required. The name of the context to delete. Format: + # `projects//agent/sessions//contexts/`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_agent_session_context(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v2beta1/{+name}', options) + command.response_representation = Google::Apis::DialogflowV2beta1::Empty::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the specified context. + # @param [String] name + # Required. The name of the context. Format: + # `projects//agent/sessions//contexts/`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Context] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Context] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_agent_session_context(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+name}', options) + command.response_representation = Google::Apis::DialogflowV2beta1::Context::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Context + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns the list of all contexts in the specified session. + # @param [String] parent + # Required. The session to list all contexts from. + # Format: `projects//agent/sessions/`. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return in a single page. By + # default 100 and at most 1000. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous list request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::ListContextsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::ListContextsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_agent_session_contexts(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+parent}/contexts', options) + command.response_representation = Google::Apis::DialogflowV2beta1::ListContextsResponse::Representation + command.response_class = Google::Apis::DialogflowV2beta1::ListContextsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the specified context. + # @param [String] name + # Required. The unique identifier of the context. Format: + # `projects//agent/sessions//contexts/`. + # Note: The Context ID is always converted to lowercase. + # @param [Google::Apis::DialogflowV2beta1::Context] context_object + # @param [String] update_mask + # Optional. The mask to control which fields get updated. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Context] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Context] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_agent_session_context(name, context_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v2beta1/{+name}', options) + command.request_representation = Google::Apis::DialogflowV2beta1::Context::Representation + command.request_object = context_object + command.response_representation = Google::Apis::DialogflowV2beta1::Context::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Context + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a session entity type. + # @param [String] parent + # Required. The session to create a session entity type for. + # Format: `projects//agent/sessions/`. + # @param [Google::Apis::DialogflowV2beta1::SessionEntityType] session_entity_type_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::SessionEntityType] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::SessionEntityType] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_agent_session_entity_type(parent, session_entity_type_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2beta1/{+parent}/entityTypes', options) + command.request_representation = Google::Apis::DialogflowV2beta1::SessionEntityType::Representation + command.request_object = session_entity_type_object + command.response_representation = Google::Apis::DialogflowV2beta1::SessionEntityType::Representation + command.response_class = Google::Apis::DialogflowV2beta1::SessionEntityType + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specified session entity type. + # @param [String] name + # Required. The name of the entity type to delete. Format: + # `projects//agent/sessions//entityTypes/`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v2beta1/{+name}', options) + command.response_representation = Google::Apis::DialogflowV2beta1::Empty::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves the specified session entity type. + # @param [String] name + # Required. The name of the session entity type. Format: + # `projects//agent/sessions//entityTypes/`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::SessionEntityType] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::SessionEntityType] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_agent_session_entity_type(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+name}', options) + command.response_representation = Google::Apis::DialogflowV2beta1::SessionEntityType::Representation + command.response_class = Google::Apis::DialogflowV2beta1::SessionEntityType + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns the list of all session entity types in the specified session. + # @param [String] parent + # Required. The session to list all session entity types from. + # Format: `projects//agent/sessions/`. + # @param [Fixnum] page_size + # Optional. The maximum number of items to return in a single page. By + # default 100 and at most 1000. + # @param [String] page_token + # Optional. The next_page_token value returned from a previous list request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::ListSessionEntityTypesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::ListSessionEntityTypesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_agent_session_entity_types(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+parent}/entityTypes', options) + command.response_representation = Google::Apis::DialogflowV2beta1::ListSessionEntityTypesResponse::Representation + command.response_class = Google::Apis::DialogflowV2beta1::ListSessionEntityTypesResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates the specified session entity type. + # @param [String] name + # Required. The unique identifier of this session entity type. Format: + # `projects//agent/sessions//entityTypes/`. + # @param [Google::Apis::DialogflowV2beta1::SessionEntityType] session_entity_type_object + # @param [String] update_mask + # Optional. The mask to control which fields get updated. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::SessionEntityType] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::SessionEntityType] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_agent_session_entity_type(name, session_entity_type_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v2beta1/{+name}', options) + command.request_representation = Google::Apis::DialogflowV2beta1::SessionEntityType::Representation + command.request_object = session_entity_type_object + command.response_representation = Google::Apis::DialogflowV2beta1::SessionEntityType::Representation + command.response_class = Google::Apis::DialogflowV2beta1::SessionEntityType + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of a long-running operation. Clients can use this + # method to poll the operation result at intervals as recommended by the API + # service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV2beta1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV2beta1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2beta1/{+name}', options) + command.response_representation = Google::Apis::DialogflowV2beta1::Operation::Representation + command.response_class = Google::Apis::DialogflowV2beta1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/dlp_v2beta1.rb b/generated/google/apis/dlp_v2beta1.rb index 36997dfd0..e0268dc6f 100644 --- a/generated/google/apis/dlp_v2beta1.rb +++ b/generated/google/apis/dlp_v2beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/dlp/docs/ module DlpV2beta1 VERSION = 'V2beta1' - REVISION = '20170928' + REVISION = '20171121' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/dlp_v2beta1/classes.rb b/generated/google/apis/dlp_v2beta1/classes.rb index d2c656658..a6d33b2ad 100644 --- a/generated/google/apis/dlp_v2beta1/classes.rb +++ b/generated/google/apis/dlp_v2beta1/classes.rb @@ -179,6 +179,47 @@ module Google end end + # An auxiliary table contains statistical information on the relative + # frequency of different quasi-identifiers values. It has one or several + # quasi-identifiers columns, and one column that indicates the relative + # frequency of each quasi-identifier tuple. + # If a tuple is present in the data but not in the auxiliary table, the + # corresponding relative frequency is assumed to be zero (and thus, the + # tuple is highly reidentifiable). + class GooglePrivacyDlpV2beta1AuxiliaryTable + include Google::Apis::Core::Hashable + + # Quasi-identifier columns. [required] + # Corresponds to the JSON property `quasiIds` + # @return [Array] + attr_accessor :quasi_ids + + # General identifier of a data field in a storage service. + # Corresponds to the JSON property `relativeFrequency` + # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1FieldId] + attr_accessor :relative_frequency + + # Message defining the location of a BigQuery table. A table is uniquely + # identified by its project_id, dataset_id, and table_name. Within a query + # a table is often referenced with a string in the format of: + # `:.` or + # `..`. + # Corresponds to the JSON property `table` + # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1BigQueryTable] + attr_accessor :table + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @quasi_ids = args[:quasi_ids] if args.key?(:quasi_ids) + @relative_frequency = args[:relative_frequency] if args.key?(:relative_frequency) + @table = args[:table] if args.key?(:table) + end + end + # Options defining BigQuery table and row identifiers. class GooglePrivacyDlpV2beta1BigQueryOptions include Google::Apis::Core::Hashable @@ -790,13 +831,13 @@ module Google end end - # Replaces an identifier with an surrogate using FPE with the FFX + # Replaces an identifier with a surrogate using FPE with the FFX # mode of operation. # The identifier must be representable by the US-ASCII character set. # For a given crypto key and context, the same identifier will be # replaced with the same surrogate. - # Note that a given identifier must be either the empty string or be at - # least two characters long. + # Identifiers must be at least two characters long. + # In the case that the identifier is the empty string, it will be skipped. class GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig include Google::Apis::Core::Hashable @@ -849,6 +890,49 @@ module Google end end + # Custom information type provided by the user. Used to find domain-specific + # sensitive information configurable to the data in question. + class GooglePrivacyDlpV2beta1CustomInfoType + include Google::Apis::Core::Hashable + + # Custom information type based on a dictionary of words or phrases. This can + # be used to match sensitive information specific to the data, such as a list + # of employee IDs or job titles. + # Dictionary words are case-insensitive and all characters other than letters + # and digits in the unicode [Basic Multilingual + # Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29# + # Basic_Multilingual_Plane) + # will be replaced with whitespace when scanning for matches, so the + # dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", + # "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters + # surrounding any match must be of a different type than the adjacent + # characters within the word, so letters must be next to non-letters and + # digits next to non-digits. For example, the dictionary word "jen" will + # match the first three letters of the text "jen123" but will return no + # matches for "jennifer". + # Dictionary words containing a large number of characters that are not + # letters or digits may result in unexpected findings because such characters + # are treated as whitespace. + # Corresponds to the JSON property `dictionary` + # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1Dictionary] + attr_accessor :dictionary + + # Type of information detected by the API. + # Corresponds to the JSON property `infoType` + # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1InfoType] + attr_accessor :info_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dictionary = args[:dictionary] if args.key?(:dictionary) + @info_type = args[:info_type] if args.key?(:info_type) + end + end + # Record key for a finding in Cloud Datastore. class GooglePrivacyDlpV2beta1DatastoreKey include Google::Apis::Core::Hashable @@ -1020,6 +1104,42 @@ module Google end end + # Custom information type based on a dictionary of words or phrases. This can + # be used to match sensitive information specific to the data, such as a list + # of employee IDs or job titles. + # Dictionary words are case-insensitive and all characters other than letters + # and digits in the unicode [Basic Multilingual + # Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29# + # Basic_Multilingual_Plane) + # will be replaced with whitespace when scanning for matches, so the + # dictionary phrase "Sam Johnson" will match all three phrases "sam johnson", + # "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters + # surrounding any match must be of a different type than the adjacent + # characters within the word, so letters must be next to non-letters and + # digits next to non-digits. For example, the dictionary word "jen" will + # match the first three letters of the text "jen123" but will return no + # matches for "jennifer". + # Dictionary words containing a large number of characters that are not + # letters or digits may result in unexpected findings because such characters + # are treated as whitespace. + class GooglePrivacyDlpV2beta1Dictionary + include Google::Apis::Core::Hashable + + # Message defining a list of words or phrases to search for in the data. + # Corresponds to the JSON property `wordList` + # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1WordList] + attr_accessor :word_list + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @word_list = args[:word_list] if args.key?(:word_list) + end + end + # An entity in a dataset is a field or set of fields that correspond to a # single person. For example, in medical records the `EntityId` might be # a patient identifier, or for financial records it might be an account @@ -1092,7 +1212,7 @@ module Google class GooglePrivacyDlpV2beta1FieldTransformation include Google::Apis::Core::Hashable - # A condition for determing whether a transformation should be applied to + # A condition for determining whether a transformation should be applied to # a field. # Corresponds to the JSON property `condition` # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1RecordCondition] @@ -1272,7 +1392,7 @@ module Google end end - # Configuration for determing how redaction of images should occur. + # Configuration for determining how redaction of images should occur. class GooglePrivacyDlpV2beta1ImageRedactionConfig include Google::Apis::Core::Hashable @@ -1462,6 +1582,11 @@ module Google class GooglePrivacyDlpV2beta1InspectConfig include Google::Apis::Core::Hashable + # Custom info types provided by the user. + # Corresponds to the JSON property `customInfoTypes` + # @return [Array] + attr_accessor :custom_info_types + # When true, excludes type information of the findings. # Corresponds to the JSON property `excludeTypes` # @return [Boolean] @@ -1503,6 +1628,7 @@ module Google # Update properties of this object def update!(**args) + @custom_info_types = args[:custom_info_types] if args.key?(:custom_info_types) @exclude_types = args[:exclude_types] if args.key?(:exclude_types) @include_quote = args[:include_quote] if args.key?(:include_quote) @info_type_limits = args[:info_type_limits] if args.key?(:info_type_limits) @@ -1788,6 +1914,144 @@ module Google end end + # Reidentifiability metric. This corresponds to a risk model similar to what + # is called "journalist risk" in the literature, except the attack dataset is + # statistically modeled instead of being perfectly known. This can be done + # using publicly available data (like the US Census), or using a custom + # statistical model (indicated as one or several BigQuery tables), or by + # extrapolating from the distribution of values in the input dataset. + class GooglePrivacyDlpV2beta1KMapEstimationConfig + include Google::Apis::Core::Hashable + + # Several auxiliary tables can be used in the analysis. Each custom_tag + # used to tag a quasi-identifiers column must appear in exactly one column + # of one auxiliary table. + # Corresponds to the JSON property `auxiliaryTables` + # @return [Array] + attr_accessor :auxiliary_tables + + # Fields considered to be quasi-identifiers. No two columns can have the + # same tag. [required] + # Corresponds to the JSON property `quasiIds` + # @return [Array] + attr_accessor :quasi_ids + + # ISO 3166-1 alpha-2 region code to use in the statistical modeling. + # Required if no column is tagged with a region-specific InfoType (like + # US_ZIP_5) or a region code. + # Corresponds to the JSON property `regionCode` + # @return [String] + attr_accessor :region_code + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @auxiliary_tables = args[:auxiliary_tables] if args.key?(:auxiliary_tables) + @quasi_ids = args[:quasi_ids] if args.key?(:quasi_ids) + @region_code = args[:region_code] if args.key?(:region_code) + end + end + + # A KMapEstimationHistogramBucket message with the following values: + # min_anonymity: 3 + # max_anonymity: 5 + # frequency: 42 + # means that there are 42 records whose quasi-identifier values correspond + # to 3, 4 or 5 people in the overlying population. An important particular + # case is when min_anonymity = max_anonymity = 1: the frequency field then + # corresponds to the number of uniquely identifiable records. + class GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket + include Google::Apis::Core::Hashable + + # Number of records within these anonymity bounds. + # Corresponds to the JSON property `bucketSize` + # @return [Fixnum] + attr_accessor :bucket_size + + # Sample of quasi-identifier tuple values in this bucket. The total + # number of classes returned per bucket is capped at 20. + # Corresponds to the JSON property `bucketValues` + # @return [Array] + attr_accessor :bucket_values + + # Always greater than or equal to min_anonymity. + # Corresponds to the JSON property `maxAnonymity` + # @return [Fixnum] + attr_accessor :max_anonymity + + # Always positive. + # Corresponds to the JSON property `minAnonymity` + # @return [Fixnum] + attr_accessor :min_anonymity + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bucket_size = args[:bucket_size] if args.key?(:bucket_size) + @bucket_values = args[:bucket_values] if args.key?(:bucket_values) + @max_anonymity = args[:max_anonymity] if args.key?(:max_anonymity) + @min_anonymity = args[:min_anonymity] if args.key?(:min_anonymity) + end + end + + # A tuple of values for the quasi-identifier columns. + class GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues + include Google::Apis::Core::Hashable + + # The estimated anonymity for these quasi-identifier values. + # Corresponds to the JSON property `estimatedAnonymity` + # @return [Fixnum] + attr_accessor :estimated_anonymity + + # The quasi-identifier values. + # Corresponds to the JSON property `quasiIdsValues` + # @return [Array] + attr_accessor :quasi_ids_values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @estimated_anonymity = args[:estimated_anonymity] if args.key?(:estimated_anonymity) + @quasi_ids_values = args[:quasi_ids_values] if args.key?(:quasi_ids_values) + end + end + + # Result of the reidentifiability analysis. Note that these results are an + # estimation, not exact values. + class GooglePrivacyDlpV2beta1KMapEstimationResult + include Google::Apis::Core::Hashable + + # The intervals [min_anonymity, max_anonymity] do not overlap. If a value + # doesn't correspond to any such interval, the associated frequency is + # zero. For example, the following records: + # `min_anonymity: 1, max_anonymity: 1, frequency: 17` + # `min_anonymity: 2, max_anonymity: 3, frequency: 42` + # `min_anonymity: 5, max_anonymity: 10, frequency: 99` + # mean that there are no record with an estimated anonymity of 4, 5, or + # larger than 10. + # Corresponds to the JSON property `kMapEstimationHistogram` + # @return [Array] + attr_accessor :k_map_estimation_histogram + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @k_map_estimation_histogram = args[:k_map_estimation_histogram] if args.key?(:k_map_estimation_histogram) + end + end + # A unique identifier for a Datastore entity. # If a key's partition ID or any of its path kinds or names are # reserved/read-only, the key is reserved/read-only. @@ -2317,13 +2581,13 @@ module Google # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1CryptoHashConfig] attr_accessor :crypto_hash_config - # Replaces an identifier with an surrogate using FPE with the FFX + # Replaces an identifier with a surrogate using FPE with the FFX # mode of operation. # The identifier must be representable by the US-ASCII character set. # For a given crypto key and context, the same identifier will be # replaced with the same surrogate. - # Note that a given identifier must be either the empty string or be at - # least two characters long. + # Identifiers must be at least two characters long. + # In the case that the identifier is the empty string, it will be skipped. # Corresponds to the JSON property `cryptoReplaceFfxFpeConfig` # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1CryptoReplaceFfxFpeConfig] attr_accessor :crypto_replace_ffx_fpe_config @@ -2398,6 +2662,16 @@ module Google # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KAnonymityConfig] attr_accessor :k_anonymity_config + # Reidentifiability metric. This corresponds to a risk model similar to what + # is called "journalist risk" in the literature, except the attack dataset is + # statistically modeled instead of being perfectly known. This can be done + # using publicly available data (like the US Census), or using a custom + # statistical model (indicated as one or several BigQuery tables), or by + # extrapolating from the distribution of values in the input dataset. + # Corresponds to the JSON property `kMapEstimationConfig` + # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KMapEstimationConfig] + attr_accessor :k_map_estimation_config + # l-diversity metric, used for analysis of reidentification risk. # Corresponds to the JSON property `lDiversityConfig` # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1LDiversityConfig] @@ -2417,6 +2691,7 @@ module Google def update!(**args) @categorical_stats_config = args[:categorical_stats_config] if args.key?(:categorical_stats_config) @k_anonymity_config = args[:k_anonymity_config] if args.key?(:k_anonymity_config) + @k_map_estimation_config = args[:k_map_estimation_config] if args.key?(:k_map_estimation_config) @l_diversity_config = args[:l_diversity_config] if args.key?(:l_diversity_config) @numerical_stats_config = args[:numerical_stats_config] if args.key?(:numerical_stats_config) end @@ -2461,6 +2736,32 @@ module Google end end + # A quasi-identifier column has a custom_tag, used to know which column + # in the data corresponds to which column in the statistical model. + class GooglePrivacyDlpV2beta1QuasiIdField + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `customTag` + # @return [String] + attr_accessor :custom_tag + + # General identifier of a data field in a storage service. + # Corresponds to the JSON property `field` + # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1FieldId] + attr_accessor :field + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_tag = args[:custom_tag] if args.key?(:custom_tag) + @field = args[:field] if args.key?(:field) + end + end + # Generic half-open interval [start, end) class GooglePrivacyDlpV2beta1Range include Google::Apis::Core::Hashable @@ -2486,7 +2787,7 @@ module Google end end - # A condition for determing whether a transformation should be applied to + # A condition for determining whether a transformation should be applied to # a field. class GooglePrivacyDlpV2beta1RecordCondition include Google::Apis::Core::Hashable @@ -2536,7 +2837,7 @@ module Google class GooglePrivacyDlpV2beta1RecordSuppression include Google::Apis::Core::Hashable - # A condition for determing whether a transformation should be applied to + # A condition for determining whether a transformation should be applied to # a field. # Corresponds to the JSON property `condition` # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1RecordCondition] @@ -2765,6 +3066,12 @@ module Google # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KAnonymityResult] attr_accessor :k_anonymity_result + # Result of the reidentifiability analysis. Note that these results are an + # estimation, not exact values. + # Corresponds to the JSON property `kMapEstimationResult` + # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KMapEstimationResult] + attr_accessor :k_map_estimation_result + # Result of the l-diversity computation. # Corresponds to the JSON property `lDiversityResult` # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1LDiversityResult] @@ -2783,6 +3090,7 @@ module Google def update!(**args) @categorical_stats_result = args[:categorical_stats_result] if args.key?(:categorical_stats_result) @k_anonymity_result = args[:k_anonymity_result] if args.key?(:k_anonymity_result) + @k_map_estimation_result = args[:k_map_estimation_result] if args.key?(:k_map_estimation_result) @l_diversity_result = args[:l_diversity_result] if args.key?(:l_diversity_result) @numerical_stats_result = args[:numerical_stats_result] if args.key?(:numerical_stats_result) end @@ -2916,6 +3224,51 @@ module Google end end + # A column with a semantic tag attached. + class GooglePrivacyDlpV2beta1TaggedField + include Google::Apis::Core::Hashable + + # A column can be tagged with a custom tag. In this case, the user must + # indicate an auxiliary table that contains statistical information on + # the possible values of this column (below). + # Corresponds to the JSON property `customTag` + # @return [String] + attr_accessor :custom_tag + + # General identifier of a data field in a storage service. + # Corresponds to the JSON property `field` + # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1FieldId] + attr_accessor :field + + # 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); + # ` + # The JSON representation for `Empty` is empty JSON object ````. + # Corresponds to the JSON property `inferred` + # @return [Google::Apis::DlpV2beta1::GoogleProtobufEmpty] + attr_accessor :inferred + + # Type of information detected by the API. + # Corresponds to the JSON property `infoType` + # @return [Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1InfoType] + attr_accessor :info_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_tag = args[:custom_tag] if args.key?(:custom_tag) + @field = args[:field] if args.key?(:field) + @inferred = args[:inferred] if args.key?(:inferred) + @info_type = args[:info_type] if args.key?(:info_type) + end + end + # For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a # portion of the value. class GooglePrivacyDlpV2beta1TimePartConfig @@ -3122,6 +3475,27 @@ module Google end end + # Message defining a list of words or phrases to search for in the data. + class GooglePrivacyDlpV2beta1WordList + include Google::Apis::Core::Hashable + + # Words or phrases defining the dictionary. The dictionary must contain + # at least one phrase and every phrase must contain at least 2 characters + # that are letters or digits. [required] + # Corresponds to the JSON property `words` + # @return [Array] + attr_accessor :words + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @words = args[:words] if args.key?(:words) + end + end + # 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: diff --git a/generated/google/apis/dlp_v2beta1/representations.rb b/generated/google/apis/dlp_v2beta1/representations.rb index fb16c1c95..f5a6becbe 100644 --- a/generated/google/apis/dlp_v2beta1/representations.rb +++ b/generated/google/apis/dlp_v2beta1/representations.rb @@ -46,6 +46,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GooglePrivacyDlpV2beta1AuxiliaryTable + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GooglePrivacyDlpV2beta1BigQueryOptions class Representation < Google::Apis::Core::JsonRepresentation; end @@ -172,6 +178,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GooglePrivacyDlpV2beta1CustomInfoType + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GooglePrivacyDlpV2beta1DatastoreKey class Representation < Google::Apis::Core::JsonRepresentation; end @@ -208,6 +220,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GooglePrivacyDlpV2beta1Dictionary + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GooglePrivacyDlpV2beta1EntityId class Representation < Google::Apis::Core::JsonRepresentation; end @@ -358,6 +376,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GooglePrivacyDlpV2beta1KMapEstimationConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GooglePrivacyDlpV2beta1KMapEstimationResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GooglePrivacyDlpV2beta1Key class Representation < Google::Apis::Core::JsonRepresentation; end @@ -484,6 +526,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GooglePrivacyDlpV2beta1QuasiIdField + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GooglePrivacyDlpV2beta1Range class Representation < Google::Apis::Core::JsonRepresentation; end @@ -592,6 +640,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GooglePrivacyDlpV2beta1TaggedField + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GooglePrivacyDlpV2beta1TimePartConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -628,6 +682,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GooglePrivacyDlpV2beta1WordList + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleProtobufEmpty class Representation < Google::Apis::Core::JsonRepresentation; end @@ -689,6 +749,18 @@ module Google end end + class GooglePrivacyDlpV2beta1AuxiliaryTable + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :quasi_ids, as: 'quasiIds', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1QuasiIdField, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1QuasiIdField::Representation + + property :relative_frequency, as: 'relativeFrequency', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1FieldId, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1FieldId::Representation + + property :table, as: 'table', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1BigQueryTable, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1BigQueryTable::Representation + + end + end + class GooglePrivacyDlpV2beta1BigQueryOptions # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -891,6 +963,16 @@ module Google end end + class GooglePrivacyDlpV2beta1CustomInfoType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dictionary, as: 'dictionary', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1Dictionary, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1Dictionary::Representation + + property :info_type, as: 'infoType', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1InfoType, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1InfoType::Representation + + end + end + class GooglePrivacyDlpV2beta1DatastoreKey # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -952,6 +1034,14 @@ module Google end end + class GooglePrivacyDlpV2beta1Dictionary + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :word_list, as: 'wordList', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1WordList, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1WordList::Representation + + end + end + class GooglePrivacyDlpV2beta1EntityId # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1098,6 +1188,8 @@ module Google class GooglePrivacyDlpV2beta1InspectConfig # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :custom_info_types, as: 'customInfoTypes', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1CustomInfoType, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1CustomInfoType::Representation + property :exclude_types, as: 'excludeTypes' property :include_quote, as: 'includeQuote' collection :info_type_limits, as: 'infoTypeLimits', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1InfoTypeLimit, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1InfoTypeLimit::Representation @@ -1198,6 +1290,45 @@ module Google end end + class GooglePrivacyDlpV2beta1KMapEstimationConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :auxiliary_tables, as: 'auxiliaryTables', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1AuxiliaryTable, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1AuxiliaryTable::Representation + + collection :quasi_ids, as: 'quasiIds', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1TaggedField, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1TaggedField::Representation + + property :region_code, as: 'regionCode' + end + end + + class GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bucket_size, :numeric_string => true, as: 'bucketSize' + collection :bucket_values, as: 'bucketValues', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues::Representation + + property :max_anonymity, :numeric_string => true, as: 'maxAnonymity' + property :min_anonymity, :numeric_string => true, as: 'minAnonymity' + end + end + + class GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :estimated_anonymity, :numeric_string => true, as: 'estimatedAnonymity' + collection :quasi_ids_values, as: 'quasiIdsValues', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1Value, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1Value::Representation + + end + end + + class GooglePrivacyDlpV2beta1KMapEstimationResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :k_map_estimation_histogram, as: 'kMapEstimationHistogram', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket::Representation + + end + end + class GooglePrivacyDlpV2beta1Key # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1392,6 +1523,8 @@ module Google property :k_anonymity_config, as: 'kAnonymityConfig', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KAnonymityConfig, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KAnonymityConfig::Representation + property :k_map_estimation_config, as: 'kMapEstimationConfig', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KMapEstimationConfig, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KMapEstimationConfig::Representation + property :l_diversity_config, as: 'lDiversityConfig', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1LDiversityConfig, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1LDiversityConfig::Representation property :numerical_stats_config, as: 'numericalStatsConfig', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1NumericalStatsConfig, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1NumericalStatsConfig::Representation @@ -1414,6 +1547,15 @@ module Google end end + class GooglePrivacyDlpV2beta1QuasiIdField + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :custom_tag, as: 'customTag' + property :field, as: 'field', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1FieldId, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1FieldId::Representation + + end + end + class GooglePrivacyDlpV2beta1Range # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1527,6 +1669,8 @@ module Google property :k_anonymity_result, as: 'kAnonymityResult', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KAnonymityResult, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KAnonymityResult::Representation + property :k_map_estimation_result, as: 'kMapEstimationResult', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KMapEstimationResult, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1KMapEstimationResult::Representation + property :l_diversity_result, as: 'lDiversityResult', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1LDiversityResult, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1LDiversityResult::Representation property :numerical_stats_result, as: 'numericalStatsResult', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1NumericalStatsResult, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1NumericalStatsResult::Representation @@ -1580,6 +1724,19 @@ module Google end end + class GooglePrivacyDlpV2beta1TaggedField + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :custom_tag, as: 'customTag' + property :field, as: 'field', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1FieldId, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1FieldId::Representation + + property :inferred, as: 'inferred', class: Google::Apis::DlpV2beta1::GoogleProtobufEmpty, decorator: Google::Apis::DlpV2beta1::GoogleProtobufEmpty::Representation + + property :info_type, as: 'infoType', class: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1InfoType, decorator: Google::Apis::DlpV2beta1::GooglePrivacyDlpV2beta1InfoType::Representation + + end + end + class GooglePrivacyDlpV2beta1TimePartConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1643,6 +1800,13 @@ module Google end end + class GooglePrivacyDlpV2beta1WordList + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :words, as: 'words' + end + end + class GoogleProtobufEmpty # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/dns_v1beta2.rb b/generated/google/apis/dns_v1beta2.rb new file mode 100644 index 000000000..ffbebb281 --- /dev/null +++ b/generated/google/apis/dns_v1beta2.rb @@ -0,0 +1,43 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/dns_v1beta2/service.rb' +require 'google/apis/dns_v1beta2/classes.rb' +require 'google/apis/dns_v1beta2/representations.rb' + +module Google + module Apis + # Google Cloud DNS API + # + # Configures and serves authoritative DNS records. + # + # @see https://developers.google.com/cloud-dns + module DnsV1beta2 + VERSION = 'V1beta2' + REVISION = '20171019' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + + # View your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' + + # View your DNS records hosted by Google Cloud DNS + AUTH_NDEV_CLOUDDNS_READONLY = 'https://www.googleapis.com/auth/ndev.clouddns.readonly' + + # View and manage your DNS records hosted by Google Cloud DNS + AUTH_NDEV_CLOUDDNS_READWRITE = 'https://www.googleapis.com/auth/ndev.clouddns.readwrite' + end + end +end diff --git a/generated/google/apis/dns_v1beta2/classes.rb b/generated/google/apis/dns_v1beta2/classes.rb new file mode 100644 index 000000000..5b4705780 --- /dev/null +++ b/generated/google/apis/dns_v1beta2/classes.rb @@ -0,0 +1,915 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DnsV1beta2 + + # An atomic update to a collection of ResourceRecordSets. + class Change + include Google::Apis::Core::Hashable + + # Which ResourceRecordSets to add? + # Corresponds to the JSON property `additions` + # @return [Array] + attr_accessor :additions + + # Which ResourceRecordSets to remove? Must match existing data exactly. + # Corresponds to the JSON property `deletions` + # @return [Array] + attr_accessor :deletions + + # Unique identifier for the resource; defined by the server (output only). + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # If the DNS queries for the zone will be served. + # Corresponds to the JSON property `isServing` + # @return [Boolean] + attr_accessor :is_serving + alias_method :is_serving?, :is_serving + + # Identifies what kind of resource this is. Value: the fixed string "dns#change". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The time that this operation was started by the server (output only). This is + # in RFC3339 text format. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # Status of the operation (output only). + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @additions = args[:additions] if args.key?(:additions) + @deletions = args[:deletions] if args.key?(:deletions) + @id = args[:id] if args.key?(:id) + @is_serving = args[:is_serving] if args.key?(:is_serving) + @kind = args[:kind] if args.key?(:kind) + @start_time = args[:start_time] if args.key?(:start_time) + @status = args[:status] if args.key?(:status) + end + end + + # The response to a request to enumerate Changes to a ResourceRecordSets + # collection. + class ChangesListResponse + include Google::Apis::Core::Hashable + + # The requested changes. + # Corresponds to the JSON property `changes` + # @return [Array] + attr_accessor :changes + + # Elements common to every response. + # Corresponds to the JSON property `header` + # @return [Google::Apis::DnsV1beta2::ResponseHeader] + attr_accessor :header + + # Type of resource. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your pagination token. + # In this way you can retrieve the complete contents of even very large + # collections one page at a time. However, if the contents of the collection + # change between the first and last paginated list request, the set of all + # elements returned will be an inconsistent view of the collection. There is no + # way to retrieve a "snapshot" of collections larger than the maximum page size. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @changes = args[:changes] if args.key?(:changes) + @header = args[:header] if args.key?(:header) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # A DNSSEC key pair. + class DnsKey + include Google::Apis::Core::Hashable + + # String mnemonic specifying the DNSSEC algorithm of this key. Immutable after + # creation time. + # Corresponds to the JSON property `algorithm` + # @return [String] + attr_accessor :algorithm + + # The time that this resource was created in the control plane. This is in + # RFC3339 text format. Output only. + # Corresponds to the JSON property `creationTime` + # @return [String] + attr_accessor :creation_time + + # A mutable string of at most 1024 characters associated with this resource for + # the user's convenience. Has no effect on the resource's function. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. + # These digests are needed to construct a DS record that points at this DNS key. + # Output only. + # Corresponds to the JSON property `digests` + # @return [Array] + attr_accessor :digests + + # Unique identifier for the resource; defined by the server (output only). + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Active keys will be used to sign subsequent changes to the ManagedZone. + # Inactive keys will still be present as DNSKEY Resource Records for the use of + # resolvers validating existing signatures. + # Corresponds to the JSON property `isActive` + # @return [Boolean] + attr_accessor :is_active + alias_method :is_active?, :is_active + + # Length of the key in bits. Specified at creation time then immutable. + # Corresponds to the JSON property `keyLength` + # @return [Fixnum] + attr_accessor :key_length + + # The key tag is a non-cryptographic hash of the a DNSKEY resource record + # associated with this DnsKey. The key tag can be used to identify a DNSKEY more + # quickly (but it is not a unique identifier). In particular, the key tag is + # used in a parent zone's DS record to point at the DNSKEY in this child + # ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm + # to calculate it is specified in RFC4034 Appendix B. Output only. + # Corresponds to the JSON property `keyTag` + # @return [Fixnum] + attr_accessor :key_tag + + # Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Base64 encoded public half of this key. Output only. + # Corresponds to the JSON property `publicKey` + # @return [String] + attr_accessor :public_key + + # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the + # Secure Entry Point flag set and, when active, will be used to sign only + # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag + # will be cleared and this key will be used to sign only resource record sets of + # other types. Immutable after creation time. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @algorithm = args[:algorithm] if args.key?(:algorithm) + @creation_time = args[:creation_time] if args.key?(:creation_time) + @description = args[:description] if args.key?(:description) + @digests = args[:digests] if args.key?(:digests) + @id = args[:id] if args.key?(:id) + @is_active = args[:is_active] if args.key?(:is_active) + @key_length = args[:key_length] if args.key?(:key_length) + @key_tag = args[:key_tag] if args.key?(:key_tag) + @kind = args[:kind] if args.key?(:kind) + @public_key = args[:public_key] if args.key?(:public_key) + @type = args[:type] if args.key?(:type) + end + end + + # + class DnsKeyDigest + include Google::Apis::Core::Hashable + + # The base-16 encoded bytes of this digest. Suitable for use in a DS resource + # record. + # Corresponds to the JSON property `digest` + # @return [String] + attr_accessor :digest + + # Specifies the algorithm used to calculate this digest. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @digest = args[:digest] if args.key?(:digest) + @type = args[:type] if args.key?(:type) + end + end + + # Parameters for DnsKey key generation. Used for generating initial keys for a + # new ManagedZone and as default when adding a new DnsKey. + class DnsKeySpec + include Google::Apis::Core::Hashable + + # String mnemonic specifying the DNSSEC algorithm of this key. + # Corresponds to the JSON property `algorithm` + # @return [String] + attr_accessor :algorithm + + # Length of the keys in bits. + # Corresponds to the JSON property `keyLength` + # @return [Fixnum] + attr_accessor :key_length + + # One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the + # Secure Entry Point flag set and, when active, will be used to sign only + # resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag + # will be cleared and this key will be used to sign only resource record sets of + # other types. + # Corresponds to the JSON property `keyType` + # @return [String] + attr_accessor :key_type + + # Identifies what kind of resource this is. Value: the fixed string "dns# + # dnsKeySpec". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @algorithm = args[:algorithm] if args.key?(:algorithm) + @key_length = args[:key_length] if args.key?(:key_length) + @key_type = args[:key_type] if args.key?(:key_type) + @kind = args[:kind] if args.key?(:kind) + end + end + + # The response to a request to enumerate DnsKeys in a ManagedZone. + class DnsKeysListResponse + include Google::Apis::Core::Hashable + + # The requested resources. + # Corresponds to the JSON property `dnsKeys` + # @return [Array] + attr_accessor :dns_keys + + # Elements common to every response. + # Corresponds to the JSON property `header` + # @return [Google::Apis::DnsV1beta2::ResponseHeader] + attr_accessor :header + + # Type of resource. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your pagination token. + # In this way you can retrieve the complete contents of even very large + # collections one page at a time. However, if the contents of the collection + # change between the first and last paginated list request, the set of all + # elements returned will be an inconsistent view of the collection. There is no + # way to retrieve a "snapshot" of collections larger than the maximum page size. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dns_keys = args[:dns_keys] if args.key?(:dns_keys) + @header = args[:header] if args.key?(:header) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # A zone is a subtree of the DNS namespace under one administrative + # responsibility. A ManagedZone is a resource that represents a DNS zone hosted + # by the Cloud DNS service. + class ManagedZone + include Google::Apis::Core::Hashable + + # The time that this resource was created on the server. This is in RFC3339 text + # format. Output only. + # Corresponds to the JSON property `creationTime` + # @return [String] + attr_accessor :creation_time + + # A mutable string of at most 1024 characters associated with this resource for + # the user's convenience. Has no effect on the managed zone's function. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The DNS name of this managed zone, for instance "example.com.". + # Corresponds to the JSON property `dnsName` + # @return [String] + attr_accessor :dns_name + + # DNSSEC configuration. + # Corresponds to the JSON property `dnssecConfig` + # @return [Google::Apis::DnsV1beta2::ManagedZoneDnsSecConfig] + attr_accessor :dnssec_config + + # Unique identifier for the resource; defined by the server (output only) + # Corresponds to the JSON property `id` + # @return [Fixnum] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string "dns# + # managedZone". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # User assigned name for this resource. Must be unique within the project. The + # name must be 1-63 characters long, must begin with a letter, end with a letter + # or digit, and only contain lowercase letters, digits or dashes. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet + # is a set of DNS name servers that all host the same ManagedZones. Most users + # will leave this field unset. + # Corresponds to the JSON property `nameServerSet` + # @return [String] + attr_accessor :name_server_set + + # Delegate your managed_zone to these virtual name servers; defined by the + # server (output only) + # Corresponds to the JSON property `nameServers` + # @return [Array] + attr_accessor :name_servers + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creation_time = args[:creation_time] if args.key?(:creation_time) + @description = args[:description] if args.key?(:description) + @dns_name = args[:dns_name] if args.key?(:dns_name) + @dnssec_config = args[:dnssec_config] if args.key?(:dnssec_config) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @name_server_set = args[:name_server_set] if args.key?(:name_server_set) + @name_servers = args[:name_servers] if args.key?(:name_servers) + end + end + + # + class ManagedZoneDnsSecConfig + include Google::Apis::Core::Hashable + + # Specifies parameters that will be used for generating initial DnsKeys for this + # ManagedZone. Output only while state is not OFF. + # Corresponds to the JSON property `defaultKeySpecs` + # @return [Array] + attr_accessor :default_key_specs + + # Identifies what kind of resource this is. Value: the fixed string "dns# + # managedZoneDnsSecConfig". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Specifies the mechanism used to provide authenticated denial-of-existence + # responses. Output only while state is not OFF. + # Corresponds to the JSON property `nonExistence` + # @return [String] + attr_accessor :non_existence + + # Specifies whether DNSSEC is enabled, and what mode it is in. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @default_key_specs = args[:default_key_specs] if args.key?(:default_key_specs) + @kind = args[:kind] if args.key?(:kind) + @non_existence = args[:non_existence] if args.key?(:non_existence) + @state = args[:state] if args.key?(:state) + end + end + + # + class ManagedZoneOperationsListResponse + include Google::Apis::Core::Hashable + + # Elements common to every response. + # Corresponds to the JSON property `header` + # @return [Google::Apis::DnsV1beta2::ResponseHeader] + attr_accessor :header + + # Type of resource. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your page token. + # In this way you can retrieve the complete contents of even very large + # collections one page at a time. However, if the contents of the collection + # change between the first and last paginated list request, the set of all + # elements returned will be an inconsistent view of the collection. There is no + # way to retrieve a consistent snapshot of a collection larger than the maximum + # page size. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The operation resources. + # Corresponds to the JSON property `operations` + # @return [Array] + attr_accessor :operations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @header = args[:header] if args.key?(:header) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @operations = args[:operations] if args.key?(:operations) + end + end + + # + class ManagedZonesDeleteResponse + include Google::Apis::Core::Hashable + + # Elements common to every response. + # Corresponds to the JSON property `header` + # @return [Google::Apis::DnsV1beta2::ResponseHeader] + attr_accessor :header + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @header = args[:header] if args.key?(:header) + end + end + + # + class ManagedZonesListResponse + include Google::Apis::Core::Hashable + + # Elements common to every response. + # Corresponds to the JSON property `header` + # @return [Google::Apis::DnsV1beta2::ResponseHeader] + attr_accessor :header + + # Type of resource. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The managed zone resources. + # Corresponds to the JSON property `managedZones` + # @return [Array] + attr_accessor :managed_zones + + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your page token. + # In this way you can retrieve the complete contents of even very large + # collections one page at a time. However, if the contents of the collection + # change between the first and last paginated list request, the set of all + # elements returned will be an inconsistent view of the collection. There is no + # way to retrieve a consistent snapshot of a collection larger than the maximum + # page size. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @header = args[:header] if args.key?(:header) + @kind = args[:kind] if args.key?(:kind) + @managed_zones = args[:managed_zones] if args.key?(:managed_zones) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # An operation represents a successful mutation performed on a Cloud DNS + # resource. Operations provide: - An audit log of server resource mutations. - A + # way to recover/retry API calls in the case where the response is never + # received by the caller. Use the caller specified client_operation_id. + class Operation + include Google::Apis::Core::Hashable + + # Only populated if the operation targeted a DnsKey (output only). + # Corresponds to the JSON property `dnsKeyContext` + # @return [Google::Apis::DnsV1beta2::OperationDnsKeyContext] + attr_accessor :dns_key_context + + # Unique identifier for the resource. This is the client_operation_id if the + # client specified it when the mutation was initiated, otherwise, it is + # generated by the server. The name must be 1-63 characters long and match the + # regular expression [-a-z0-9]? (output only) + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string "dns# + # operation". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The time that this operation was started by the server. This is in RFC3339 + # text format (output only). + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # Status of the operation. Can be one of the following: "PENDING" or "DONE" ( + # output only). + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # Type of the operation. Operations include insert, update, and delete (output + # only). + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # User who requested the operation, for example: user@example.com. cloud-dns- + # system for operations automatically done by the system. (output only) + # Corresponds to the JSON property `user` + # @return [String] + attr_accessor :user + + # Only populated if the operation targeted a ManagedZone (output only). + # Corresponds to the JSON property `zoneContext` + # @return [Google::Apis::DnsV1beta2::OperationManagedZoneContext] + attr_accessor :zone_context + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dns_key_context = args[:dns_key_context] if args.key?(:dns_key_context) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @start_time = args[:start_time] if args.key?(:start_time) + @status = args[:status] if args.key?(:status) + @type = args[:type] if args.key?(:type) + @user = args[:user] if args.key?(:user) + @zone_context = args[:zone_context] if args.key?(:zone_context) + end + end + + # + class OperationDnsKeyContext + include Google::Apis::Core::Hashable + + # A DNSSEC key pair. + # Corresponds to the JSON property `newValue` + # @return [Google::Apis::DnsV1beta2::DnsKey] + attr_accessor :new_value + + # A DNSSEC key pair. + # Corresponds to the JSON property `oldValue` + # @return [Google::Apis::DnsV1beta2::DnsKey] + attr_accessor :old_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @new_value = args[:new_value] if args.key?(:new_value) + @old_value = args[:old_value] if args.key?(:old_value) + end + end + + # + class OperationManagedZoneContext + include Google::Apis::Core::Hashable + + # A zone is a subtree of the DNS namespace under one administrative + # responsibility. A ManagedZone is a resource that represents a DNS zone hosted + # by the Cloud DNS service. + # Corresponds to the JSON property `newValue` + # @return [Google::Apis::DnsV1beta2::ManagedZone] + attr_accessor :new_value + + # A zone is a subtree of the DNS namespace under one administrative + # responsibility. A ManagedZone is a resource that represents a DNS zone hosted + # by the Cloud DNS service. + # Corresponds to the JSON property `oldValue` + # @return [Google::Apis::DnsV1beta2::ManagedZone] + attr_accessor :old_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @new_value = args[:new_value] if args.key?(:new_value) + @old_value = args[:old_value] if args.key?(:old_value) + end + end + + # A project resource. The project is a top level container for resources + # including Cloud DNS ManagedZones. Projects can be created only in the APIs + # console. + class Project + include Google::Apis::Core::Hashable + + # User assigned unique identifier for the resource (output only). + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. Value: the fixed string "dns#project" + # . + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Unique numeric identifier for the resource; defined by the server (output only) + # . + # Corresponds to the JSON property `number` + # @return [Fixnum] + attr_accessor :number + + # Limits associated with a Project. + # Corresponds to the JSON property `quota` + # @return [Google::Apis::DnsV1beta2::Quota] + attr_accessor :quota + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @number = args[:number] if args.key?(:number) + @quota = args[:quota] if args.key?(:quota) + end + end + + # Limits associated with a Project. + class Quota + include Google::Apis::Core::Hashable + + # Maximum allowed number of DnsKeys per ManagedZone. + # Corresponds to the JSON property `dnsKeysPerManagedZone` + # @return [Fixnum] + attr_accessor :dns_keys_per_managed_zone + + # Identifies what kind of resource this is. Value: the fixed string "dns#quota". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Maximum allowed number of managed zones in the project. + # Corresponds to the JSON property `managedZones` + # @return [Fixnum] + attr_accessor :managed_zones + + # Maximum allowed number of ResourceRecords per ResourceRecordSet. + # Corresponds to the JSON property `resourceRecordsPerRrset` + # @return [Fixnum] + attr_accessor :resource_records_per_rrset + + # Maximum allowed number of ResourceRecordSets to add per ChangesCreateRequest. + # Corresponds to the JSON property `rrsetAdditionsPerChange` + # @return [Fixnum] + attr_accessor :rrset_additions_per_change + + # Maximum allowed number of ResourceRecordSets to delete per + # ChangesCreateRequest. + # Corresponds to the JSON property `rrsetDeletionsPerChange` + # @return [Fixnum] + attr_accessor :rrset_deletions_per_change + + # Maximum allowed number of ResourceRecordSets per zone in the project. + # Corresponds to the JSON property `rrsetsPerManagedZone` + # @return [Fixnum] + attr_accessor :rrsets_per_managed_zone + + # Maximum allowed size for total rrdata in one ChangesCreateRequest in bytes. + # Corresponds to the JSON property `totalRrdataSizePerChange` + # @return [Fixnum] + attr_accessor :total_rrdata_size_per_change + + # DNSSEC algorithm and key length types that can be used for DnsKeys. + # Corresponds to the JSON property `whitelistedKeySpecs` + # @return [Array] + attr_accessor :whitelisted_key_specs + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dns_keys_per_managed_zone = args[:dns_keys_per_managed_zone] if args.key?(:dns_keys_per_managed_zone) + @kind = args[:kind] if args.key?(:kind) + @managed_zones = args[:managed_zones] if args.key?(:managed_zones) + @resource_records_per_rrset = args[:resource_records_per_rrset] if args.key?(:resource_records_per_rrset) + @rrset_additions_per_change = args[:rrset_additions_per_change] if args.key?(:rrset_additions_per_change) + @rrset_deletions_per_change = args[:rrset_deletions_per_change] if args.key?(:rrset_deletions_per_change) + @rrsets_per_managed_zone = args[:rrsets_per_managed_zone] if args.key?(:rrsets_per_managed_zone) + @total_rrdata_size_per_change = args[:total_rrdata_size_per_change] if args.key?(:total_rrdata_size_per_change) + @whitelisted_key_specs = args[:whitelisted_key_specs] if args.key?(:whitelisted_key_specs) + end + end + + # A unit of data that will be returned by the DNS servers. + class ResourceRecordSet + include Google::Apis::Core::Hashable + + # Identifies what kind of resource this is. Value: the fixed string "dns# + # resourceRecordSet". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # For example, www.example.com. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1). + # Corresponds to the JSON property `rrdatas` + # @return [Array] + attr_accessor :rrdatas + + # As defined in RFC 4034 (section 3.2). + # Corresponds to the JSON property `signatureRrdatas` + # @return [Array] + attr_accessor :signature_rrdatas + + # Number of seconds that this ResourceRecordSet can be cached by resolvers. + # Corresponds to the JSON property `ttl` + # @return [Fixnum] + attr_accessor :ttl + + # The identifier of a supported record type, for example, A, AAAA, MX, TXT, and + # so on. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @rrdatas = args[:rrdatas] if args.key?(:rrdatas) + @signature_rrdatas = args[:signature_rrdatas] if args.key?(:signature_rrdatas) + @ttl = args[:ttl] if args.key?(:ttl) + @type = args[:type] if args.key?(:type) + end + end + + # + class ResourceRecordSetsListResponse + include Google::Apis::Core::Hashable + + # Elements common to every response. + # Corresponds to the JSON property `header` + # @return [Google::Apis::DnsV1beta2::ResponseHeader] + attr_accessor :header + + # Type of resource. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The presence of this field indicates that there exist more results following + # your last page of results in pagination order. To fetch them, make another + # list request using this value as your pagination token. + # In this way you can retrieve the complete contents of even very large + # collections one page at a time. However, if the contents of the collection + # change between the first and last paginated list request, the set of all + # elements returned will be an inconsistent view of the collection. There is no + # way to retrieve a consistent snapshot of a collection larger than the maximum + # page size. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The resource record set resources. + # Corresponds to the JSON property `rrsets` + # @return [Array] + attr_accessor :rrsets + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @header = args[:header] if args.key?(:header) + @kind = args[:kind] if args.key?(:kind) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @rrsets = args[:rrsets] if args.key?(:rrsets) + end + end + + # Elements common to every response. + class ResponseHeader + include Google::Apis::Core::Hashable + + # For mutating operation requests that completed successfully. This is the + # client_operation_id if the client specified it, otherwise it is generated by + # the server (output only). + # Corresponds to the JSON property `operationId` + # @return [String] + attr_accessor :operation_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operation_id = args[:operation_id] if args.key?(:operation_id) + end + end + end + end +end diff --git a/generated/google/apis/dns_v1beta2/representations.rb b/generated/google/apis/dns_v1beta2/representations.rb new file mode 100644 index 000000000..0aed5a090 --- /dev/null +++ b/generated/google/apis/dns_v1beta2/representations.rb @@ -0,0 +1,368 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DnsV1beta2 + + class Change + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ChangesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DnsKey + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DnsKeyDigest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DnsKeySpec + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DnsKeysListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ManagedZone + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ManagedZoneDnsSecConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ManagedZoneOperationsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ManagedZonesDeleteResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ManagedZonesListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperationDnsKeyContext + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperationManagedZoneContext + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Project + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Quota + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResourceRecordSet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResourceRecordSetsListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResponseHeader + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Change + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :additions, as: 'additions', class: Google::Apis::DnsV1beta2::ResourceRecordSet, decorator: Google::Apis::DnsV1beta2::ResourceRecordSet::Representation + + collection :deletions, as: 'deletions', class: Google::Apis::DnsV1beta2::ResourceRecordSet, decorator: Google::Apis::DnsV1beta2::ResourceRecordSet::Representation + + property :id, as: 'id' + property :is_serving, as: 'isServing' + property :kind, as: 'kind' + property :start_time, as: 'startTime' + property :status, as: 'status' + end + end + + class ChangesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :changes, as: 'changes', class: Google::Apis::DnsV1beta2::Change, decorator: Google::Apis::DnsV1beta2::Change::Representation + + property :header, as: 'header', class: Google::Apis::DnsV1beta2::ResponseHeader, decorator: Google::Apis::DnsV1beta2::ResponseHeader::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class DnsKey + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :algorithm, as: 'algorithm' + property :creation_time, as: 'creationTime' + property :description, as: 'description' + collection :digests, as: 'digests', class: Google::Apis::DnsV1beta2::DnsKeyDigest, decorator: Google::Apis::DnsV1beta2::DnsKeyDigest::Representation + + property :id, as: 'id' + property :is_active, as: 'isActive' + property :key_length, as: 'keyLength' + property :key_tag, as: 'keyTag' + property :kind, as: 'kind' + property :public_key, as: 'publicKey' + property :type, as: 'type' + end + end + + class DnsKeyDigest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :digest, as: 'digest' + property :type, as: 'type' + end + end + + class DnsKeySpec + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :algorithm, as: 'algorithm' + property :key_length, as: 'keyLength' + property :key_type, as: 'keyType' + property :kind, as: 'kind' + end + end + + class DnsKeysListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :dns_keys, as: 'dnsKeys', class: Google::Apis::DnsV1beta2::DnsKey, decorator: Google::Apis::DnsV1beta2::DnsKey::Representation + + property :header, as: 'header', class: Google::Apis::DnsV1beta2::ResponseHeader, decorator: Google::Apis::DnsV1beta2::ResponseHeader::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + end + end + + class ManagedZone + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creation_time, as: 'creationTime' + property :description, as: 'description' + property :dns_name, as: 'dnsName' + property :dnssec_config, as: 'dnssecConfig', class: Google::Apis::DnsV1beta2::ManagedZoneDnsSecConfig, decorator: Google::Apis::DnsV1beta2::ManagedZoneDnsSecConfig::Representation + + property :id, :numeric_string => true, as: 'id' + property :kind, as: 'kind' + property :name, as: 'name' + property :name_server_set, as: 'nameServerSet' + collection :name_servers, as: 'nameServers' + end + end + + class ManagedZoneDnsSecConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :default_key_specs, as: 'defaultKeySpecs', class: Google::Apis::DnsV1beta2::DnsKeySpec, decorator: Google::Apis::DnsV1beta2::DnsKeySpec::Representation + + property :kind, as: 'kind' + property :non_existence, as: 'nonExistence' + property :state, as: 'state' + end + end + + class ManagedZoneOperationsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :header, as: 'header', class: Google::Apis::DnsV1beta2::ResponseHeader, decorator: Google::Apis::DnsV1beta2::ResponseHeader::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::DnsV1beta2::Operation, decorator: Google::Apis::DnsV1beta2::Operation::Representation + + end + end + + class ManagedZonesDeleteResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :header, as: 'header', class: Google::Apis::DnsV1beta2::ResponseHeader, decorator: Google::Apis::DnsV1beta2::ResponseHeader::Representation + + end + end + + class ManagedZonesListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :header, as: 'header', class: Google::Apis::DnsV1beta2::ResponseHeader, decorator: Google::Apis::DnsV1beta2::ResponseHeader::Representation + + property :kind, as: 'kind' + collection :managed_zones, as: 'managedZones', class: Google::Apis::DnsV1beta2::ManagedZone, decorator: Google::Apis::DnsV1beta2::ManagedZone::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dns_key_context, as: 'dnsKeyContext', class: Google::Apis::DnsV1beta2::OperationDnsKeyContext, decorator: Google::Apis::DnsV1beta2::OperationDnsKeyContext::Representation + + property :id, as: 'id' + property :kind, as: 'kind' + property :start_time, as: 'startTime' + property :status, as: 'status' + property :type, as: 'type' + property :user, as: 'user' + property :zone_context, as: 'zoneContext', class: Google::Apis::DnsV1beta2::OperationManagedZoneContext, decorator: Google::Apis::DnsV1beta2::OperationManagedZoneContext::Representation + + end + end + + class OperationDnsKeyContext + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :new_value, as: 'newValue', class: Google::Apis::DnsV1beta2::DnsKey, decorator: Google::Apis::DnsV1beta2::DnsKey::Representation + + property :old_value, as: 'oldValue', class: Google::Apis::DnsV1beta2::DnsKey, decorator: Google::Apis::DnsV1beta2::DnsKey::Representation + + end + end + + class OperationManagedZoneContext + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :new_value, as: 'newValue', class: Google::Apis::DnsV1beta2::ManagedZone, decorator: Google::Apis::DnsV1beta2::ManagedZone::Representation + + property :old_value, as: 'oldValue', class: Google::Apis::DnsV1beta2::ManagedZone, decorator: Google::Apis::DnsV1beta2::ManagedZone::Representation + + end + end + + class Project + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :kind, as: 'kind' + property :number, :numeric_string => true, as: 'number' + property :quota, as: 'quota', class: Google::Apis::DnsV1beta2::Quota, decorator: Google::Apis::DnsV1beta2::Quota::Representation + + end + end + + class Quota + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dns_keys_per_managed_zone, as: 'dnsKeysPerManagedZone' + property :kind, as: 'kind' + property :managed_zones, as: 'managedZones' + property :resource_records_per_rrset, as: 'resourceRecordsPerRrset' + property :rrset_additions_per_change, as: 'rrsetAdditionsPerChange' + property :rrset_deletions_per_change, as: 'rrsetDeletionsPerChange' + property :rrsets_per_managed_zone, as: 'rrsetsPerManagedZone' + property :total_rrdata_size_per_change, as: 'totalRrdataSizePerChange' + collection :whitelisted_key_specs, as: 'whitelistedKeySpecs', class: Google::Apis::DnsV1beta2::DnsKeySpec, decorator: Google::Apis::DnsV1beta2::DnsKeySpec::Representation + + end + end + + class ResourceRecordSet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :name, as: 'name' + collection :rrdatas, as: 'rrdatas' + collection :signature_rrdatas, as: 'signatureRrdatas' + property :ttl, as: 'ttl' + property :type, as: 'type' + end + end + + class ResourceRecordSetsListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :header, as: 'header', class: Google::Apis::DnsV1beta2::ResponseHeader, decorator: Google::Apis::DnsV1beta2::ResponseHeader::Representation + + property :kind, as: 'kind' + property :next_page_token, as: 'nextPageToken' + collection :rrsets, as: 'rrsets', class: Google::Apis::DnsV1beta2::ResourceRecordSet, decorator: Google::Apis::DnsV1beta2::ResourceRecordSet::Representation + + end + end + + class ResponseHeader + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operation_id, as: 'operationId' + end + end + end + end +end diff --git a/generated/google/apis/dns_v1beta2/service.rb b/generated/google/apis/dns_v1beta2/service.rb new file mode 100644 index 000000000..a9bbeb804 --- /dev/null +++ b/generated/google/apis/dns_v1beta2/service.rb @@ -0,0 +1,769 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DnsV1beta2 + # Google Cloud DNS API + # + # Configures and serves authoritative DNS records. + # + # @example + # require 'google/apis/dns_v1beta2' + # + # Dns = Google::Apis::DnsV1beta2 # Alias the module + # service = Dns::DnsService.new + # + # @see https://developers.google.com/cloud-dns + class DnsService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + # Overrides userIp if both are provided. + attr_accessor :quota_user + + # @return [String] + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + attr_accessor :user_ip + + def initialize + super('https://www.googleapis.com/', 'dns/v1beta2/projects/') + @batch_path = 'batch/dns/v1beta2' + end + + # Atomically update the ResourceRecordSet collection. + # @param [String] project + # Identifies the project addressed by this request. + # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. + # @param [Google::Apis::DnsV1beta2::Change] change_object + # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::Change] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::Change] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_change(project, managed_zone, change_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/managedZones/{managedZone}/changes', options) + command.request_representation = Google::Apis::DnsV1beta2::Change::Representation + command.request_object = change_object + command.response_representation = Google::Apis::DnsV1beta2::Change::Representation + command.response_class = Google::Apis::DnsV1beta2::Change + command.params['project'] = project unless project.nil? + command.params['managedZone'] = managed_zone unless managed_zone.nil? + command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Fetch the representation of an existing Change. + # @param [String] project + # Identifies the project addressed by this request. + # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. + # @param [String] change_id + # The identifier of the requested change, from a previous + # ResourceRecordSetsChangeResponse. + # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::Change] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::Change] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_change(project, managed_zone, change_id, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/managedZones/{managedZone}/changes/{changeId}', options) + command.response_representation = Google::Apis::DnsV1beta2::Change::Representation + command.response_class = Google::Apis::DnsV1beta2::Change + command.params['project'] = project unless project.nil? + command.params['managedZone'] = managed_zone unless managed_zone.nil? + command.params['changeId'] = change_id unless change_id.nil? + command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Enumerate Changes to a ResourceRecordSet collection. + # @param [String] project + # Identifies the project addressed by this request. + # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. + # @param [Fixnum] max_results + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. + # @param [String] page_token + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. + # @param [String] sort_by + # Sorting criterion. The only supported value is change sequence. + # @param [String] sort_order + # Sorting order direction: 'ascending' or 'descending'. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::ChangesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::ChangesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_changes(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, sort_order: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/managedZones/{managedZone}/changes', options) + command.response_representation = Google::Apis::DnsV1beta2::ChangesListResponse::Representation + command.response_class = Google::Apis::DnsV1beta2::ChangesListResponse + command.params['project'] = project unless project.nil? + command.params['managedZone'] = managed_zone unless managed_zone.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['sortBy'] = sort_by unless sort_by.nil? + command.query['sortOrder'] = sort_order unless sort_order.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Fetch the representation of an existing DnsKey. + # @param [String] project + # Identifies the project addressed by this request. + # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. + # @param [String] dns_key_id + # The identifier of the requested DnsKey. + # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. + # @param [String] digest_type + # An optional comma-separated list of digest types to compute and display for + # key signing keys. If omitted, the recommended digest type will be computed and + # displayed. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::DnsKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::DnsKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_dns_key(project, managed_zone, dns_key_id, client_operation_id: nil, digest_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/managedZones/{managedZone}/dnsKeys/{dnsKeyId}', options) + command.response_representation = Google::Apis::DnsV1beta2::DnsKey::Representation + command.response_class = Google::Apis::DnsV1beta2::DnsKey + command.params['project'] = project unless project.nil? + command.params['managedZone'] = managed_zone unless managed_zone.nil? + command.params['dnsKeyId'] = dns_key_id unless dns_key_id.nil? + command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? + command.query['digestType'] = digest_type unless digest_type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Enumerate DnsKeys to a ResourceRecordSet collection. + # @param [String] project + # Identifies the project addressed by this request. + # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. + # @param [String] digest_type + # An optional comma-separated list of digest types to compute and display for + # key signing keys. If omitted, the recommended digest type will be computed and + # displayed. + # @param [Fixnum] max_results + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. + # @param [String] page_token + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::DnsKeysListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::DnsKeysListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_dns_keys(project, managed_zone, digest_type: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/managedZones/{managedZone}/dnsKeys', options) + command.response_representation = Google::Apis::DnsV1beta2::DnsKeysListResponse::Representation + command.response_class = Google::Apis::DnsV1beta2::DnsKeysListResponse + command.params['project'] = project unless project.nil? + command.params['managedZone'] = managed_zone unless managed_zone.nil? + command.query['digestType'] = digest_type unless digest_type.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Fetch the representation of an existing Operation. + # @param [String] project + # Identifies the project addressed by this request. + # @param [String] managed_zone + # Identifies the managed zone addressed by this request. + # @param [String] operation + # Identifies the operation addressed by this request. + # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_managed_zone_operation(project, managed_zone, operation, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/managedZones/{managedZone}/operations/{operation}', options) + command.response_representation = Google::Apis::DnsV1beta2::Operation::Representation + command.response_class = Google::Apis::DnsV1beta2::Operation + command.params['project'] = project unless project.nil? + command.params['managedZone'] = managed_zone unless managed_zone.nil? + command.params['operation'] = operation unless operation.nil? + command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Enumerate Operations for the given ManagedZone. + # @param [String] project + # Identifies the project addressed by this request. + # @param [String] managed_zone + # Identifies the managed zone addressed by this request. + # @param [Fixnum] max_results + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. + # @param [String] page_token + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. + # @param [String] sort_by + # Sorting criterion. The only supported values are START_TIME and ID. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::ManagedZoneOperationsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::ManagedZoneOperationsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_managed_zone_operations(project, managed_zone, max_results: nil, page_token: nil, sort_by: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/managedZones/{managedZone}/operations', options) + command.response_representation = Google::Apis::DnsV1beta2::ManagedZoneOperationsListResponse::Representation + command.response_class = Google::Apis::DnsV1beta2::ManagedZoneOperationsListResponse + command.params['project'] = project unless project.nil? + command.params['managedZone'] = managed_zone unless managed_zone.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['sortBy'] = sort_by unless sort_by.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Create a new ManagedZone. + # @param [String] project + # Identifies the project addressed by this request. + # @param [Google::Apis::DnsV1beta2::ManagedZone] managed_zone_object + # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::ManagedZone] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::ManagedZone] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_managed_zone(project, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, '{project}/managedZones', options) + command.request_representation = Google::Apis::DnsV1beta2::ManagedZone::Representation + command.request_object = managed_zone_object + command.response_representation = Google::Apis::DnsV1beta2::ManagedZone::Representation + command.response_class = Google::Apis::DnsV1beta2::ManagedZone + command.params['project'] = project unless project.nil? + command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Delete a previously created ManagedZone. + # @param [String] project + # Identifies the project addressed by this request. + # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. + # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::ManagedZonesDeleteResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::ManagedZonesDeleteResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:delete, '{project}/managedZones/{managedZone}', options) + command.response_representation = Google::Apis::DnsV1beta2::ManagedZonesDeleteResponse::Representation + command.response_class = Google::Apis::DnsV1beta2::ManagedZonesDeleteResponse + command.params['project'] = project unless project.nil? + command.params['managedZone'] = managed_zone unless managed_zone.nil? + command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Fetch the representation of an existing ManagedZone. + # @param [String] project + # Identifies the project addressed by this request. + # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. + # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::ManagedZone] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::ManagedZone] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_managed_zone(project, managed_zone, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/managedZones/{managedZone}', options) + command.response_representation = Google::Apis::DnsV1beta2::ManagedZone::Representation + command.response_class = Google::Apis::DnsV1beta2::ManagedZone + command.params['project'] = project unless project.nil? + command.params['managedZone'] = managed_zone unless managed_zone.nil? + command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Enumerate ManagedZones that have been created but not yet deleted. + # @param [String] project + # Identifies the project addressed by this request. + # @param [String] dns_name + # Restricts the list to return only zones with this domain name. + # @param [Fixnum] max_results + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. + # @param [String] page_token + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::ManagedZonesListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::ManagedZonesListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_managed_zones(project, dns_name: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/managedZones', options) + command.response_representation = Google::Apis::DnsV1beta2::ManagedZonesListResponse::Representation + command.response_class = Google::Apis::DnsV1beta2::ManagedZonesListResponse + command.params['project'] = project unless project.nil? + command.query['dnsName'] = dns_name unless dns_name.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Update an existing ManagedZone. This method supports patch semantics. + # @param [String] project + # Identifies the project addressed by this request. + # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. + # @param [Google::Apis::DnsV1beta2::ManagedZone] managed_zone_object + # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:patch, '{project}/managedZones/{managedZone}', options) + command.request_representation = Google::Apis::DnsV1beta2::ManagedZone::Representation + command.request_object = managed_zone_object + command.response_representation = Google::Apis::DnsV1beta2::Operation::Representation + command.response_class = Google::Apis::DnsV1beta2::Operation + command.params['project'] = project unless project.nil? + command.params['managedZone'] = managed_zone unless managed_zone.nil? + command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Update an existing ManagedZone. + # @param [String] project + # Identifies the project addressed by this request. + # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. + # @param [Google::Apis::DnsV1beta2::ManagedZone] managed_zone_object + # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_managed_zone(project, managed_zone, managed_zone_object = nil, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, '{project}/managedZones/{managedZone}', options) + command.request_representation = Google::Apis::DnsV1beta2::ManagedZone::Representation + command.request_object = managed_zone_object + command.response_representation = Google::Apis::DnsV1beta2::Operation::Representation + command.response_class = Google::Apis::DnsV1beta2::Operation + command.params['project'] = project unless project.nil? + command.params['managedZone'] = managed_zone unless managed_zone.nil? + command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Fetch the representation of an existing Project. + # @param [String] project + # Identifies the project addressed by this request. + # @param [String] client_operation_id + # For mutating operation requests only. An optional identifier specified by the + # client. Must be unique for operation resources in the Operations collection. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::Project] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::Project] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project(project, client_operation_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}', options) + command.response_representation = Google::Apis::DnsV1beta2::Project::Representation + command.response_class = Google::Apis::DnsV1beta2::Project + command.params['project'] = project unless project.nil? + command.query['clientOperationId'] = client_operation_id unless client_operation_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + # Enumerate ResourceRecordSets that have been created but not yet deleted. + # @param [String] project + # Identifies the project addressed by this request. + # @param [String] managed_zone + # Identifies the managed zone addressed by this request. Can be the managed zone + # name or id. + # @param [Fixnum] max_results + # Optional. Maximum number of results to be returned. If unspecified, the server + # will decide how many results to return. + # @param [String] name + # Restricts the list to return only records with this fully qualified domain + # name. + # @param [String] page_token + # Optional. A tag returned by a previous list request that was truncated. Use + # this parameter to continue a previous list request. + # @param [String] type + # Restricts the list to return only records of this type. If present, the "name" + # parameter must also be present. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DnsV1beta2::ResourceRecordSetsListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DnsV1beta2::ResourceRecordSetsListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_resource_record_sets(project, managed_zone, max_results: nil, name: nil, page_token: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, '{project}/managedZones/{managedZone}/rrsets', options) + command.response_representation = Google::Apis::DnsV1beta2::ResourceRecordSetsListResponse::Representation + command.response_class = Google::Apis::DnsV1beta2::ResourceRecordSetsListResponse + command.params['project'] = project unless project.nil? + command.params['managedZone'] = managed_zone unless managed_zone.nil? + command.query['maxResults'] = max_results unless max_results.nil? + command.query['name'] = name unless name.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + end + end + end + end +end diff --git a/generated/google/apis/drive_v2.rb b/generated/google/apis/drive_v2.rb index 176d7c60e..8ebbc735f 100644 --- a/generated/google/apis/drive_v2.rb +++ b/generated/google/apis/drive_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/drive/ module DriveV2 VERSION = 'V2' - REVISION = '20170825' + REVISION = '20171020' # View and manage the files in your Google Drive AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/drive_v2/classes.rb b/generated/google/apis/drive_v2/classes.rb index ff47d7147..335ef55d7 100644 --- a/generated/google/apis/drive_v2/classes.rb +++ b/generated/google/apis/drive_v2/classes.rb @@ -2968,6 +2968,11 @@ module Google # @return [String] attr_accessor :color_rgb + # The time at which the Team Drive was created (RFC 3339 date-time). + # Corresponds to the JSON property `createdDate` + # @return [DateTime] + attr_accessor :created_date + # The ID of this Team Drive which is also the ID of the top level folder for # this Team Drive. # Corresponds to the JSON property `id` @@ -3004,6 +3009,7 @@ module Google @background_image_link = args[:background_image_link] if args.key?(:background_image_link) @capabilities = args[:capabilities] if args.key?(:capabilities) @color_rgb = args[:color_rgb] if args.key?(:color_rgb) + @created_date = args[:created_date] if args.key?(:created_date) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) diff --git a/generated/google/apis/drive_v2/representations.rb b/generated/google/apis/drive_v2/representations.rb index c728294a6..7c70008cb 100644 --- a/generated/google/apis/drive_v2/representations.rb +++ b/generated/google/apis/drive_v2/representations.rb @@ -990,6 +990,8 @@ module Google property :capabilities, as: 'capabilities', class: Google::Apis::DriveV2::TeamDrive::Capabilities, decorator: Google::Apis::DriveV2::TeamDrive::Capabilities::Representation property :color_rgb, as: 'colorRgb' + property :created_date, as: 'createdDate', type: DateTime + property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' diff --git a/generated/google/apis/drive_v2/service.rb b/generated/google/apis/drive_v2/service.rb index 2cbc97bdc..89ed890ee 100644 --- a/generated/google/apis/drive_v2/service.rb +++ b/generated/google/apis/drive_v2/service.rb @@ -1806,6 +1806,10 @@ module Google # The ID for the permission. # @param [Boolean] supports_team_drives # Whether the requesting application supports Team Drives. + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then the requester will be granted access if + # they are an administrator of the domain to which the item belongs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1827,11 +1831,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_permission(file_id, permission_id, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def delete_permission(file_id, permission_id, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'files/{fileId}/permissions/{permissionId}', options) command.params['fileId'] = file_id unless file_id.nil? command.params['permissionId'] = permission_id unless permission_id.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -1845,6 +1850,10 @@ module Google # The ID for the permission. # @param [Boolean] supports_team_drives # Whether the requesting application supports Team Drives. + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then the requester will be granted access if + # they are an administrator of the domain to which the item belongs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1866,13 +1875,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_permission(file_id, permission_id, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def get_permission(file_id, permission_id, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'files/{fileId}/permissions/{permissionId}', options) command.response_representation = Google::Apis::DriveV2::Permission::Representation command.response_class = Google::Apis::DriveV2::Permission command.params['fileId'] = file_id unless file_id.nil? command.params['permissionId'] = permission_id unless permission_id.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -1925,6 +1935,10 @@ module Google # parameter is ignored and an email is sent if the role is owner. # @param [Boolean] supports_team_drives # Whether the requesting application supports Team Drives. + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then the requester will be granted access if + # they are an administrator of the domain to which the item belongs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1946,7 +1960,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_permission(file_id, permission_object = nil, email_message: nil, send_notification_emails: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def insert_permission(file_id, permission_object = nil, email_message: nil, send_notification_emails: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'files/{fileId}/permissions', options) command.request_representation = Google::Apis::DriveV2::Permission::Representation command.request_object = permission_object @@ -1956,6 +1970,7 @@ module Google command.query['emailMessage'] = email_message unless email_message.nil? command.query['sendNotificationEmails'] = send_notification_emails unless send_notification_emails.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -1974,6 +1989,10 @@ module Google # be set to the value of 'nextPageToken' from the previous response. # @param [Boolean] supports_team_drives # Whether the requesting application supports Team Drives. + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then the requester will be granted access if + # they are an administrator of the domain to which the item belongs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1995,7 +2014,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_permissions(file_id, max_results: nil, page_token: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_permissions(file_id, max_results: nil, page_token: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'files/{fileId}/permissions', options) command.response_representation = Google::Apis::DriveV2::PermissionList::Representation command.response_class = Google::Apis::DriveV2::PermissionList @@ -2003,6 +2022,7 @@ module Google command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -2022,6 +2042,10 @@ module Google # @param [Boolean] transfer_ownership # Whether changing a role to 'owner' downgrades the current owners to writers. # Does nothing if the specified role is not 'owner'. + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then the requester will be granted access if + # they are an administrator of the domain to which the item belongs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2043,7 +2067,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_permission(file_id, permission_id, permission_object = nil, remove_expiration: nil, supports_team_drives: nil, transfer_ownership: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def patch_permission(file_id, permission_id, permission_object = nil, remove_expiration: nil, supports_team_drives: nil, transfer_ownership: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'files/{fileId}/permissions/{permissionId}', options) command.request_representation = Google::Apis::DriveV2::Permission::Representation command.request_object = permission_object @@ -2054,6 +2078,7 @@ module Google command.query['removeExpiration'] = remove_expiration unless remove_expiration.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? command.query['transferOwnership'] = transfer_ownership unless transfer_ownership.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -2073,6 +2098,10 @@ module Google # @param [Boolean] transfer_ownership # Whether changing a role to 'owner' downgrades the current owners to writers. # Does nothing if the specified role is not 'owner'. + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then the requester will be granted access if + # they are an administrator of the domain to which the item belongs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2094,7 +2123,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_permission(file_id, permission_id, permission_object = nil, remove_expiration: nil, supports_team_drives: nil, transfer_ownership: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def update_permission(file_id, permission_id, permission_object = nil, remove_expiration: nil, supports_team_drives: nil, transfer_ownership: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'files/{fileId}/permissions/{permissionId}', options) command.request_representation = Google::Apis::DriveV2::Permission::Representation command.request_object = permission_object @@ -2105,6 +2134,7 @@ module Google command.query['removeExpiration'] = remove_expiration unless remove_expiration.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? command.query['transferOwnership'] = transfer_ownership unless transfer_ownership.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -2946,6 +2976,10 @@ module Google # Gets a Team Drive's metadata by ID. # @param [String] team_drive_id # The ID of the Team Drive + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then the requester will be granted access if + # they are an administrator of the domain to which the Team Drive belongs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2967,11 +3001,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_teamdrive(team_drive_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def get_teamdrive(team_drive_id, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'teamdrives/{teamDriveId}', options) command.response_representation = Google::Apis::DriveV2::TeamDrive::Representation command.response_class = Google::Apis::DriveV2::TeamDrive command.params['teamDriveId'] = team_drive_id unless team_drive_id.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -3025,6 +3060,12 @@ module Google # Maximum number of Team Drives to return. # @param [String] page_token # Page token for Team Drives. + # @param [String] q + # Query string for searching Team Drives. + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then all Team Drives of the domain in which the + # requester is an administrator are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3046,12 +3087,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_teamdrives(max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_teamdrives(max_results: nil, page_token: nil, q: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'teamdrives', options) command.response_representation = Google::Apis::DriveV2::TeamDriveList::Representation command.response_class = Google::Apis::DriveV2::TeamDriveList command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['q'] = q unless q.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? diff --git a/generated/google/apis/drive_v3.rb b/generated/google/apis/drive_v3.rb index dab679289..dcdbe5f9d 100644 --- a/generated/google/apis/drive_v3.rb +++ b/generated/google/apis/drive_v3.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/drive/ module DriveV3 VERSION = 'V3' - REVISION = '20170825' + REVISION = '20171020' # View and manage the files in your Google Drive AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/drive_v3/classes.rb b/generated/google/apis/drive_v3/classes.rb index d19de8ed9..905389cdb 100644 --- a/generated/google/apis/drive_v3/classes.rb +++ b/generated/google/apis/drive_v3/classes.rb @@ -1869,6 +1869,11 @@ module Google # @return [String] attr_accessor :color_rgb + # The time at which the Team Drive was created (RFC 3339 date-time). + # Corresponds to the JSON property `createdTime` + # @return [DateTime] + attr_accessor :created_time + # The ID of this Team Drive which is also the ID of the top level folder for # this Team Drive. # Corresponds to the JSON property `id` @@ -1906,6 +1911,7 @@ module Google @background_image_link = args[:background_image_link] if args.key?(:background_image_link) @capabilities = args[:capabilities] if args.key?(:capabilities) @color_rgb = args[:color_rgb] if args.key?(:color_rgb) + @created_time = args[:created_time] if args.key?(:created_time) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) diff --git a/generated/google/apis/drive_v3/representations.rb b/generated/google/apis/drive_v3/representations.rb index b7110b7a5..5b8d41764 100644 --- a/generated/google/apis/drive_v3/representations.rb +++ b/generated/google/apis/drive_v3/representations.rb @@ -633,6 +633,8 @@ module Google property :capabilities, as: 'capabilities', class: Google::Apis::DriveV3::TeamDrive::Capabilities, decorator: Google::Apis::DriveV3::TeamDrive::Capabilities::Representation property :color_rgb, as: 'colorRgb' + property :created_time, as: 'createdTime', type: DateTime + property :id, as: 'id' property :kind, as: 'kind' property :name, as: 'name' diff --git a/generated/google/apis/drive_v3/service.rb b/generated/google/apis/drive_v3/service.rb index 62f51e98c..e4f734536 100644 --- a/generated/google/apis/drive_v3/service.rb +++ b/generated/google/apis/drive_v3/service.rb @@ -1038,6 +1038,10 @@ module Google # Whether to transfer ownership to the specified user and downgrade the current # owner to a writer. This parameter is required as an acknowledgement of the # side effect. + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then the requester will be granted access if + # they are an administrator of the domain to which the item belongs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1059,7 +1063,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_permission(file_id, permission_object = nil, email_message: nil, send_notification_email: nil, supports_team_drives: nil, transfer_ownership: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def create_permission(file_id, permission_object = nil, email_message: nil, send_notification_email: nil, supports_team_drives: nil, transfer_ownership: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'files/{fileId}/permissions', options) command.request_representation = Google::Apis::DriveV3::Permission::Representation command.request_object = permission_object @@ -1070,6 +1074,7 @@ module Google command.query['sendNotificationEmail'] = send_notification_email unless send_notification_email.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? command.query['transferOwnership'] = transfer_ownership unless transfer_ownership.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -1083,6 +1088,10 @@ module Google # The ID of the permission. # @param [Boolean] supports_team_drives # Whether the requesting application supports Team Drives. + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then the requester will be granted access if + # they are an administrator of the domain to which the item belongs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1104,11 +1113,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_permission(file_id, permission_id, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def delete_permission(file_id, permission_id, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'files/{fileId}/permissions/{permissionId}', options) command.params['fileId'] = file_id unless file_id.nil? command.params['permissionId'] = permission_id unless permission_id.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -1122,6 +1132,10 @@ module Google # The ID of the permission. # @param [Boolean] supports_team_drives # Whether the requesting application supports Team Drives. + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then the requester will be granted access if + # they are an administrator of the domain to which the item belongs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1143,13 +1157,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_permission(file_id, permission_id, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def get_permission(file_id, permission_id, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'files/{fileId}/permissions/{permissionId}', options) command.response_representation = Google::Apis::DriveV3::Permission::Representation command.response_class = Google::Apis::DriveV3::Permission command.params['fileId'] = file_id unless file_id.nil? command.params['permissionId'] = permission_id unless permission_id.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -1168,6 +1183,10 @@ module Google # be set to the value of 'nextPageToken' from the previous response. # @param [Boolean] supports_team_drives # Whether the requesting application supports Team Drives. + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then the requester will be granted access if + # they are an administrator of the domain to which the item belongs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1189,7 +1208,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_permissions(file_id, page_size: nil, page_token: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_permissions(file_id, page_size: nil, page_token: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'files/{fileId}/permissions', options) command.response_representation = Google::Apis::DriveV3::PermissionList::Representation command.response_class = Google::Apis::DriveV3::PermissionList @@ -1197,6 +1216,7 @@ module Google command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -1217,6 +1237,10 @@ module Google # Whether to transfer ownership to the specified user and downgrade the current # owner to a writer. This parameter is required as an acknowledgement of the # side effect. + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then the requester will be granted access if + # they are an administrator of the domain to which the item belongs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1238,7 +1262,7 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_permission(file_id, permission_id, permission_object = nil, remove_expiration: nil, supports_team_drives: nil, transfer_ownership: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def update_permission(file_id, permission_id, permission_object = nil, remove_expiration: nil, supports_team_drives: nil, transfer_ownership: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'files/{fileId}/permissions/{permissionId}', options) command.request_representation = Google::Apis::DriveV3::Permission::Representation command.request_object = permission_object @@ -1249,6 +1273,7 @@ module Google command.query['removeExpiration'] = remove_expiration unless remove_expiration.nil? command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil? command.query['transferOwnership'] = transfer_ownership unless transfer_ownership.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -1721,6 +1746,10 @@ module Google # Gets a Team Drive's metadata by ID. # @param [String] team_drive_id # The ID of the Team Drive + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then the requester will be granted access if + # they are an administrator of the domain to which the Team Drive belongs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1742,11 +1771,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_teamdrive(team_drive_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def get_teamdrive(team_drive_id, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'teamdrives/{teamDriveId}', options) command.response_representation = Google::Apis::DriveV3::TeamDrive::Representation command.response_class = Google::Apis::DriveV3::TeamDrive command.params['teamDriveId'] = team_drive_id unless team_drive_id.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? @@ -1758,6 +1788,12 @@ module Google # Maximum number of Team Drives to return. # @param [String] page_token # Page token for Team Drives. + # @param [String] q + # Query string for searching Team Drives. + # @param [Boolean] use_domain_admin_access + # Whether the request should be treated as if it was issued by a domain + # administrator; if set to true, then all Team Drives of the domain in which the + # requester is an administrator are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1779,12 +1815,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_teamdrives(page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + def list_teamdrives(page_size: nil, page_token: nil, q: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'teamdrives', options) command.response_representation = Google::Apis::DriveV3::TeamDriveList::Representation command.response_class = Google::Apis::DriveV3::TeamDriveList command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['q'] = q unless q.nil? + command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? diff --git a/generated/google/apis/firebasedynamiclinks_v1.rb b/generated/google/apis/firebasedynamiclinks_v1.rb index 583c7025f..a677a3bce 100644 --- a/generated/google/apis/firebasedynamiclinks_v1.rb +++ b/generated/google/apis/firebasedynamiclinks_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://firebase.google.com/docs/dynamic-links/ module FirebasedynamiclinksV1 VERSION = 'V1' - REVISION = '20170907' + REVISION = '20171108' # View and administer all your Firebase data and settings AUTH_FIREBASE = 'https://www.googleapis.com/auth/firebase' diff --git a/generated/google/apis/firebasedynamiclinks_v1/classes.rb b/generated/google/apis/firebasedynamiclinks_v1/classes.rb index 5f7796eee..889e1ba69 100644 --- a/generated/google/apis/firebasedynamiclinks_v1/classes.rb +++ b/generated/google/apis/firebasedynamiclinks_v1/classes.rb @@ -153,6 +153,25 @@ module Google end end + # Desktop related attributes to the Dynamic Link. + class DesktopInfo + include Google::Apis::Core::Hashable + + # Link to open on desktop. + # Corresponds to the JSON property `desktopFallbackLink` + # @return [String] + attr_accessor :desktop_fallback_link + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @desktop_fallback_link = args[:desktop_fallback_link] if args.key?(:desktop_fallback_link) + end + end + # Signals associated with the device making the request. class DeviceInfo include Google::Apis::Core::Hashable @@ -167,6 +186,14 @@ module Google # @return [String] attr_accessor :language_code + # Device language code raw setting. + # iOS does returns language code in different format than iOS WebView. + # For example WebView returns en_US, but iOS returns en-US. + # Field below will return raw value returned by iOS. + # Corresponds to the JSON property `languageCodeRaw` + # @return [String] + attr_accessor :language_code_raw + # Device display resolution height. # Corresponds to the JSON property `screenResolutionHeight` # @return [Fixnum] @@ -190,6 +217,7 @@ module Google def update!(**args) @device_model_name = args[:device_model_name] if args.key?(:device_model_name) @language_code = args[:language_code] if args.key?(:language_code) + @language_code_raw = args[:language_code_raw] if args.key?(:language_code_raw) @screen_resolution_height = args[:screen_resolution_height] if args.key?(:screen_resolution_height) @screen_resolution_width = args[:screen_resolution_width] if args.key?(:screen_resolution_width) @timezone = args[:timezone] if args.key?(:timezone) @@ -241,6 +269,11 @@ module Google # @return [Google::Apis::FirebasedynamiclinksV1::AndroidInfo] attr_accessor :android_info + # Desktop related attributes to the Dynamic Link. + # Corresponds to the JSON property `desktopInfo` + # @return [Google::Apis::FirebasedynamiclinksV1::DesktopInfo] + attr_accessor :desktop_info + # Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl # [Learn more](https://firebase.google.com/docs/dynamic-links/android/receive) # on how to set up Dynamic Link domain associated with your Firebase project. @@ -283,6 +316,7 @@ module Google def update!(**args) @analytics_info = args[:analytics_info] if args.key?(:analytics_info) @android_info = args[:android_info] if args.key?(:android_info) + @desktop_info = args[:desktop_info] if args.key?(:desktop_info) @dynamic_link_domain = args[:dynamic_link_domain] if args.key?(:dynamic_link_domain) @ios_info = args[:ios_info] if args.key?(:ios_info) @link = args[:link] if args.key?(:link) diff --git a/generated/google/apis/firebasedynamiclinks_v1/representations.rb b/generated/google/apis/firebasedynamiclinks_v1/representations.rb index 08eebc559..eaf5888e1 100644 --- a/generated/google/apis/firebasedynamiclinks_v1/representations.rb +++ b/generated/google/apis/firebasedynamiclinks_v1/representations.rb @@ -46,6 +46,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class DesktopInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class DeviceInfo class Representation < Google::Apis::Core::JsonRepresentation; end @@ -165,11 +171,19 @@ module Google end end + class DesktopInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :desktop_fallback_link, as: 'desktopFallbackLink' + end + end + class DeviceInfo # @private class Representation < Google::Apis::Core::JsonRepresentation property :device_model_name, as: 'deviceModelName' property :language_code, as: 'languageCode' + property :language_code_raw, as: 'languageCodeRaw' property :screen_resolution_height, :numeric_string => true, as: 'screenResolutionHeight' property :screen_resolution_width, :numeric_string => true, as: 'screenResolutionWidth' property :timezone, as: 'timezone' @@ -192,6 +206,8 @@ module Google property :android_info, as: 'androidInfo', class: Google::Apis::FirebasedynamiclinksV1::AndroidInfo, decorator: Google::Apis::FirebasedynamiclinksV1::AndroidInfo::Representation + property :desktop_info, as: 'desktopInfo', class: Google::Apis::FirebasedynamiclinksV1::DesktopInfo, decorator: Google::Apis::FirebasedynamiclinksV1::DesktopInfo::Representation + property :dynamic_link_domain, as: 'dynamicLinkDomain' property :ios_info, as: 'iosInfo', class: Google::Apis::FirebasedynamiclinksV1::IosInfo, decorator: Google::Apis::FirebasedynamiclinksV1::IosInfo::Representation diff --git a/generated/google/apis/firebaseremoteconfig_v1.rb b/generated/google/apis/firebaseremoteconfig_v1.rb index 075146ab6..0207dbb2b 100644 --- a/generated/google/apis/firebaseremoteconfig_v1.rb +++ b/generated/google/apis/firebaseremoteconfig_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://firebase.google.com/docs/remote-config/ module FirebaseremoteconfigV1 VERSION = 'V1' - REVISION = '20170830' + REVISION = '20171016' end end end diff --git a/generated/google/apis/firebaseremoteconfig_v1/classes.rb b/generated/google/apis/firebaseremoteconfig_v1/classes.rb index 6e2eda0c4..207a0f07a 100644 --- a/generated/google/apis/firebaseremoteconfig_v1/classes.rb +++ b/generated/google/apis/firebaseremoteconfig_v1/classes.rb @@ -25,7 +25,7 @@ module Google # * # The RemoteConfig consists of a list of conditions (which can be # thought of as named "if" statements) and a map of parameters (parameter key - # to a stucture containing an optional default value, as well as a optional + # to a structure containing an optional default value, as well as a optional # submap of (condition name to value when that condition is true). class RemoteConfig include Google::Apis::Core::Hashable @@ -74,6 +74,15 @@ module Google class RemoteConfigCondition include Google::Apis::Core::Hashable + # Optional. + # A description for this Condition. Length must be less than or equal to + # 100 characters (or more precisely, unicode code points, which is defined in + # java/com/google/wireless/android/config/ConstsExporter.java). + # A description may contain any Unicode characters + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + # Required. # Corresponds to the JSON property `expression` # @return [String] @@ -105,6 +114,7 @@ module Google # Update properties of this object def update!(**args) + @description = args[:description] if args.key?(:description) @expression = args[:expression] if args.key?(:expression) @name = args[:name] if args.key?(:name) @tag_color = args[:tag_color] if args.key?(:tag_color) @@ -134,6 +144,15 @@ module Google # @return [Google::Apis::FirebaseremoteconfigV1::RemoteConfigParameterValue] attr_accessor :default_value + # Optional. + # A description for this Parameter. Length must be less than or equal to + # 100 characters (or more precisely, unicode code points, which is defined in + # java/com/google/wireless/android/config/ConstsExporter.java). + # A description may contain any Unicode characters + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + def initialize(**args) update!(**args) end @@ -142,6 +161,7 @@ module Google def update!(**args) @conditional_values = args[:conditional_values] if args.key?(:conditional_values) @default_value = args[:default_value] if args.key?(:default_value) + @description = args[:description] if args.key?(:description) end end diff --git a/generated/google/apis/firebaseremoteconfig_v1/representations.rb b/generated/google/apis/firebaseremoteconfig_v1/representations.rb index 46580c0fd..919fd44d1 100644 --- a/generated/google/apis/firebaseremoteconfig_v1/representations.rb +++ b/generated/google/apis/firebaseremoteconfig_v1/representations.rb @@ -59,6 +59,7 @@ module Google class RemoteConfigCondition # @private class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' property :expression, as: 'expression' property :name, as: 'name' property :tag_color, as: 'tagColor' @@ -72,6 +73,7 @@ module Google property :default_value, as: 'defaultValue', class: Google::Apis::FirebaseremoteconfigV1::RemoteConfigParameterValue, decorator: Google::Apis::FirebaseremoteconfigV1::RemoteConfigParameterValue::Representation + property :description, as: 'description' end end diff --git a/generated/google/apis/firebaserules_v1.rb b/generated/google/apis/firebaserules_v1.rb index 47e33fa8f..e3c8a41df 100644 --- a/generated/google/apis/firebaserules_v1.rb +++ b/generated/google/apis/firebaserules_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://firebase.google.com/docs/storage/security module FirebaserulesV1 VERSION = 'V1' - REVISION = '20170925' + REVISION = '20171018' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firebaserules_v1/classes.rb b/generated/google/apis/firebaserules_v1/classes.rb index 1c94a3300..3532d0488 100644 --- a/generated/google/apis/firebaserules_v1/classes.rb +++ b/generated/google/apis/firebaserules_v1/classes.rb @@ -661,6 +661,32 @@ module Google @test_cases = args[:test_cases] if args.key?(:test_cases) end end + + # The request for FirebaseRulesService.UpdateReleasePatch. + class UpdateReleaseRequest + include Google::Apis::Core::Hashable + + # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a + # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`. + # Corresponds to the JSON property `release` + # @return [Google::Apis::FirebaserulesV1::Release] + attr_accessor :release + + # Specifies which fields to update. + # Corresponds to the JSON property `updateMask` + # @return [String] + attr_accessor :update_mask + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @release = args[:release] if args.key?(:release) + @update_mask = args[:update_mask] if args.key?(:update_mask) + end + end end end end diff --git a/generated/google/apis/firebaserules_v1/representations.rb b/generated/google/apis/firebaserules_v1/representations.rb index 66614c161..ea9940ae0 100644 --- a/generated/google/apis/firebaserules_v1/representations.rb +++ b/generated/google/apis/firebaserules_v1/representations.rb @@ -136,6 +136,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class UpdateReleaseRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Arg # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -314,6 +320,15 @@ module Google end end + + class UpdateReleaseRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :release, as: 'release', class: Google::Apis::FirebaserulesV1::Release, decorator: Google::Apis::FirebaserulesV1::Release::Representation + + property :update_mask, as: 'updateMask' + end + end end end end diff --git a/generated/google/apis/firebaserules_v1/service.rb b/generated/google/apis/firebaserules_v1/service.rb index d84100e6d..37c6ba477 100644 --- a/generated/google/apis/firebaserules_v1/service.rb +++ b/generated/google/apis/firebaserules_v1/service.rb @@ -314,6 +314,43 @@ module Google execute_or_queue_command(command, &block) end + # Update a `Release` via PATCH. + # Only updates to the `ruleset_name` and `test_suite_name` fields will be + # honored. `Release` rename is not supported. To create a `Release` use the + # CreateRelease method. + # @param [String] name + # Resource name for the project which owns this `Release`. + # Format: `projects/`project_id`` + # @param [Google::Apis::FirebaserulesV1::UpdateReleaseRequest] update_release_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirebaserulesV1::Release] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirebaserulesV1::Release] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_release(name, update_release_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::FirebaserulesV1::UpdateReleaseRequest::Representation + command.request_object = update_release_request_object + command.response_representation = Google::Apis::FirebaserulesV1::Release::Representation + command.response_class = Google::Apis::FirebaserulesV1::Release + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Update a `Release`. # Only updates to the `ruleset_name` and `test_suite_name` fields will be # honored. `Release` rename is not supported. To create a `Release` use the diff --git a/generated/google/apis/firestore_v1beta1.rb b/generated/google/apis/firestore_v1beta1.rb index 867172d31..63c2c6568 100644 --- a/generated/google/apis/firestore_v1beta1.rb +++ b/generated/google/apis/firestore_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/firestore module FirestoreV1beta1 VERSION = 'V1beta1' - REVISION = '0' + REVISION = '20171107' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firestore_v1beta1/classes.rb b/generated/google/apis/firestore_v1beta1/classes.rb index 91fca0f26..37c3c416f 100644 --- a/generated/google/apis/firestore_v1beta1/classes.rb +++ b/generated/google/apis/firestore_v1beta1/classes.rb @@ -210,8 +210,7 @@ module Google class CommitRequest include Google::Apis::Core::Hashable - # If non-empty, applies all writes in this transaction, and commits it. - # Otherwise, applies the writes as if they were in their own transaction. + # If set, applies all writes in this transaction, and commits it. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -523,6 +522,7 @@ module Google # The list of transformations to apply to the fields of the document, in # order. + # This must not be empty. # Corresponds to the JSON property `fieldTransforms` # @return [Array] attr_accessor :field_transforms @@ -728,13 +728,13 @@ module Google attr_accessor :fields # The resource name of the index. + # Output only. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The state of the index. - # The state is read-only. - # @OutputOnly + # Output only. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -780,96 +780,11 @@ module Google end end - # Metadata for index operations. This metadata populates - # the metadata field of google.longrunning.Operation. - class IndexOperationMetadata - include Google::Apis::Core::Hashable - - # True if the [google.longrunning.Operation] was cancelled. If the - # cancellation is in progress, cancelled will be true but - # google.longrunning.Operation.done will be false. - # Corresponds to the JSON property `cancelled` - # @return [Boolean] - attr_accessor :cancelled - alias_method :cancelled?, :cancelled - - # Measures the progress of a particular metric. - # Corresponds to the JSON property `documentProgress` - # @return [Google::Apis::FirestoreV1beta1::Progress] - attr_accessor :document_progress - - # The time the operation ended, either successfully or otherwise. Unset if - # the operation is still active. - # Corresponds to the JSON property `endTime` - # @return [String] - attr_accessor :end_time - - # The index resource that this operation is acting on. For example: - # `projects/`project_id`/databases/`database_id`/indexes/`index_id`` - # Corresponds to the JSON property `index` - # @return [String] - attr_accessor :index - - # The type of index operation. - # Corresponds to the JSON property `operationType` - # @return [String] - attr_accessor :operation_type - - # The time that work began on the operation. - # Corresponds to the JSON property `startTime` - # @return [String] - attr_accessor :start_time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @cancelled = args[:cancelled] if args.key?(:cancelled) - @document_progress = args[:document_progress] if args.key?(:document_progress) - @end_time = args[:end_time] if args.key?(:end_time) - @index = args[:index] if args.key?(:index) - @operation_type = args[:operation_type] if args.key?(:operation_type) - @start_time = args[:start_time] if args.key?(:start_time) - end - end - # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) class LatLng include Google::Apis::Core::Hashable @@ -894,6 +809,32 @@ module Google end end + # The request for Firestore.ListCollectionIds. + class ListCollectionIdsRequest + include Google::Apis::Core::Hashable + + # The maximum number of results to return. + # Corresponds to the JSON property `pageSize` + # @return [Fixnum] + attr_accessor :page_size + + # A page token. Must be a value from + # ListCollectionIdsResponse. + # Corresponds to the JSON property `pageToken` + # @return [String] + attr_accessor :page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @page_size = args[:page_size] if args.key?(:page_size) + @page_token = args[:page_token] if args.key?(:page_token) + end + end + # The response from Firestore.ListCollectionIds. class ListCollectionIdsResponse include Google::Apis::Core::Hashable @@ -1229,33 +1170,6 @@ module Google end end - # Measures the progress of a particular metric. - class Progress - include Google::Apis::Core::Hashable - - # An estimate of how much work has been completed. Note that this may be - # greater than `work_estimated`. - # Corresponds to the JSON property `workCompleted` - # @return [Fixnum] - attr_accessor :work_completed - - # An estimate of how much work needs to be performed. Zero if the - # work estimate is unavailable. May change as work progresses. - # Corresponds to the JSON property `workEstimated` - # @return [Fixnum] - attr_accessor :work_estimated - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @work_completed = args[:work_completed] if args.key?(:work_completed) - @work_estimated = args[:work_estimated] if args.key?(:work_estimated) - end - end - # The projection of document's fields to return. class Projection include Google::Apis::Core::Hashable @@ -1841,36 +1755,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # Corresponds to the JSON property `geoPointValue` # @return [Google::Apis::FirestoreV1beta1::LatLng] attr_accessor :geo_point_value diff --git a/generated/google/apis/firestore_v1beta1/representations.rb b/generated/google/apis/firestore_v1beta1/representations.rb index e02fb15e9..1baf4532a 100644 --- a/generated/google/apis/firestore_v1beta1/representations.rb +++ b/generated/google/apis/firestore_v1beta1/representations.rb @@ -172,13 +172,13 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class IndexOperationMetadata + class LatLng class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class LatLng + class ListCollectionIdsRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -238,12 +238,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class Progress - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class Projection class Representation < Google::Apis::Core::JsonRepresentation; end @@ -576,19 +570,6 @@ module Google end end - class IndexOperationMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :cancelled, as: 'cancelled' - property :document_progress, as: 'documentProgress', class: Google::Apis::FirestoreV1beta1::Progress, decorator: Google::Apis::FirestoreV1beta1::Progress::Representation - - property :end_time, as: 'endTime' - property :index, as: 'index' - property :operation_type, as: 'operationType' - property :start_time, as: 'startTime' - end - end - class LatLng # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -597,6 +578,14 @@ module Google end end + class ListCollectionIdsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :page_size, as: 'pageSize' + property :page_token, as: 'pageToken' + end + end + class ListCollectionIdsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -686,14 +675,6 @@ module Google end end - class Progress - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :work_completed, :numeric_string => true, as: 'workCompleted' - property :work_estimated, :numeric_string => true, as: 'workEstimated' - end - end - class Projection # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/firestore_v1beta1/service.rb b/generated/google/apis/firestore_v1beta1/service.rb index 8ba351a08..d416b5e38 100644 --- a/generated/google/apis/firestore_v1beta1/service.rb +++ b/generated/google/apis/firestore_v1beta1/service.rb @@ -352,11 +352,7 @@ module Google # `projects/`project_id`/databases/`database_id`/documents/`document_path``. # For example: # `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` - # @param [Fixnum] page_size - # The maximum number of results to return. - # @param [String] page_token - # A page token. Must be a value from - # ListCollectionIdsResponse. + # @param [Google::Apis::FirestoreV1beta1::ListCollectionIdsRequest] list_collection_ids_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -374,13 +370,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_database_document_collection_ids(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_project_database_document_collection_ids(parent, list_collection_ids_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/{+parent}:listCollectionIds', options) + command.request_representation = Google::Apis::FirestoreV1beta1::ListCollectionIdsRequest::Representation + command.request_object = list_collection_ids_request_object command.response_representation = Google::Apis::FirestoreV1beta1::ListCollectionIdsResponse::Representation command.response_class = Google::Apis::FirestoreV1beta1::ListCollectionIdsResponse command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) diff --git a/generated/google/apis/genomics_v1alpha2.rb b/generated/google/apis/genomics_v1alpha2.rb index 0e7925ff8..ddcdb42f7 100644 --- a/generated/google/apis/genomics_v1alpha2.rb +++ b/generated/google/apis/genomics_v1alpha2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/genomics module GenomicsV1alpha2 VERSION = 'V1alpha2' - REVISION = '20170916' + REVISION = '20171113' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/genomics_v1alpha2/classes.rb b/generated/google/apis/genomics_v1alpha2/classes.rb index 81f347e25..e1323fe05 100644 --- a/generated/google/apis/genomics_v1alpha2/classes.rb +++ b/generated/google/apis/genomics_v1alpha2/classes.rb @@ -790,6 +790,24 @@ module Google class PipelineResources include Google::Apis::Core::Hashable + # Optional. The number of accelerators of the specified type to attach. + # By specifying this parameter, you will download and install the following + # third-party software onto your managed Compute Engine instances: + # NVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit. + # Corresponds to the JSON property `acceleratorCount` + # @return [Fixnum] + attr_accessor :accelerator_count + + # Optional. The Compute Engine defined accelerator type. + # By specifying this parameter, you will download and install the following + # third-party software onto your managed Compute Engine instances: NVIDIA® + # Tesla® drivers and NVIDIA® CUDA toolkit. + # Please see https://cloud.google.com/compute/docs/gpus/ for a list of + # available accelerator types. + # Corresponds to the JSON property `acceleratorType` + # @return [String] + attr_accessor :accelerator_type + # The size of the boot disk. Defaults to 10 (GB). # Corresponds to the JSON property `bootDiskSizeGb` # @return [Fixnum] @@ -848,6 +866,8 @@ module Google # Update properties of this object def update!(**args) + @accelerator_count = args[:accelerator_count] if args.key?(:accelerator_count) + @accelerator_type = args[:accelerator_type] if args.key?(:accelerator_type) @boot_disk_size_gb = args[:boot_disk_size_gb] if args.key?(:boot_disk_size_gb) @disks = args[:disks] if args.key?(:disks) @minimum_cpu_cores = args[:minimum_cpu_cores] if args.key?(:minimum_cpu_cores) diff --git a/generated/google/apis/genomics_v1alpha2/representations.rb b/generated/google/apis/genomics_v1alpha2/representations.rb index fa792a12b..f47a8697f 100644 --- a/generated/google/apis/genomics_v1alpha2/representations.rb +++ b/generated/google/apis/genomics_v1alpha2/representations.rb @@ -353,6 +353,8 @@ module Google class PipelineResources # @private class Representation < Google::Apis::Core::JsonRepresentation + property :accelerator_count, :numeric_string => true, as: 'acceleratorCount' + property :accelerator_type, as: 'acceleratorType' property :boot_disk_size_gb, as: 'bootDiskSizeGb' collection :disks, as: 'disks', class: Google::Apis::GenomicsV1alpha2::Disk, decorator: Google::Apis::GenomicsV1alpha2::Disk::Representation diff --git a/generated/google/apis/iam_v1.rb b/generated/google/apis/iam_v1.rb index 41884af9d..3b35a6fcb 100644 --- a/generated/google/apis/iam_v1.rb +++ b/generated/google/apis/iam_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/iam/ module IamV1 VERSION = 'V1' - REVISION = '20170922' + REVISION = '20171027' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/iam_v1/classes.rb b/generated/google/apis/iam_v1/classes.rb index 64dae1fc0..92b357fce 100644 --- a/generated/google/apis/iam_v1/classes.rb +++ b/generated/google/apis/iam_v1/classes.rb @@ -200,9 +200,8 @@ module Google # to generate the service account email address and a stable # `unique_id`. # If the account already exists, the account's resource name is returned - # in util::Status's ResourceInfo.resource_name in the format of - # projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`. The caller can - # use the name in other methods to access the account. + # in the format of projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`. The caller + # can use the name in other methods to access the account. # All other methods can identify the service account using the format # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from @@ -694,9 +693,8 @@ module Google # to generate the service account email address and a stable # `unique_id`. # If the account already exists, the account's resource name is returned - # in util::Status's ResourceInfo.resource_name in the format of - # projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`. The caller can - # use the name in other methods to access the account. + # in the format of projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT`. The caller + # can use the name in other methods to access the account. # All other methods can identify the service account using the format # `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. # Using `-` as a wildcard for the `PROJECT_ID` will infer the project from @@ -733,7 +731,7 @@ module Google # @return [String] attr_accessor :name - # @OutputOnly. The OAuth2 client id for the service account. + # @OutputOnly The OAuth2 client id for the service account. # This is used in conjunction with the OAuth2 clientconfig API to make # three legged OAuth2 (3LO) flows to access the data of Google users. # Corresponds to the JSON property `oauth2ClientId` diff --git a/generated/google/apis/language_v1.rb b/generated/google/apis/language_v1.rb index b29fabe26..62ed06afa 100644 --- a/generated/google/apis/language_v1.rb +++ b/generated/google/apis/language_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/natural-language/ module LanguageV1 VERSION = 'V1' - REVISION = '20170911' + REVISION = '20171023' # Apply machine learning models to reveal the structure and meaning of text AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language' diff --git a/generated/google/apis/language_v1/classes.rb b/generated/google/apis/language_v1/classes.rb index 3972a5964..0c12fcef2 100644 --- a/generated/google/apis/language_v1/classes.rb +++ b/generated/google/apis/language_v1/classes.rb @@ -285,6 +285,11 @@ module Google class AnnotateTextResponse include Google::Apis::Core::Hashable + # Categories identified in the input document. + # Corresponds to the JSON property `categories` + # @return [Array] + attr_accessor :categories + # Represents the feeling associated with the entire text or entities in # the text. # Corresponds to the JSON property `documentSentiment` @@ -324,6 +329,7 @@ module Google # Update properties of this object def update!(**args) + @categories = args[:categories] if args.key?(:categories) @document_sentiment = args[:document_sentiment] if args.key?(:document_sentiment) @entities = args[:entities] if args.key?(:entities) @language = args[:language] if args.key?(:language) @@ -332,6 +338,71 @@ module Google end end + # Represents a category returned from the text classifier. + class ClassificationCategory + include Google::Apis::Core::Hashable + + # The classifier's confidence of the category. Number represents how certain + # the classifier is that this category represents the given text. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # The name of the category representing the document. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @confidence = args[:confidence] if args.key?(:confidence) + @name = args[:name] if args.key?(:name) + end + end + + # The document classification request message. + class ClassifyTextRequest + include Google::Apis::Core::Hashable + + # ################################################################ # + # Represents the input to API methods. + # Corresponds to the JSON property `document` + # @return [Google::Apis::LanguageV1::Document] + attr_accessor :document + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @document = args[:document] if args.key?(:document) + end + end + + # The document classification response message. + class ClassifyTextResponse + include Google::Apis::Core::Hashable + + # Categories representing the input document. + # Corresponds to the JSON property `categories` + # @return [Array] + attr_accessor :categories + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @categories = args[:categories] if args.key?(:categories) + end + end + # Represents dependency parse tree information for a token. (For more # information on dependency labels, see # http://www.aclweb.org/anthology/P13-2017 @@ -509,6 +580,12 @@ module Google class Features include Google::Apis::Core::Hashable + # Classify the full document into categories. + # Corresponds to the JSON property `classifyText` + # @return [Boolean] + attr_accessor :classify_text + alias_method :classify_text?, :classify_text + # Extract document-level sentiment. # Corresponds to the JSON property `extractDocumentSentiment` # @return [Boolean] @@ -539,6 +616,7 @@ module Google # Update properties of this object def update!(**args) + @classify_text = args[:classify_text] if args.key?(:classify_text) @extract_document_sentiment = args[:extract_document_sentiment] if args.key?(:extract_document_sentiment) @extract_entities = args[:extract_entities] if args.key?(:extract_entities) @extract_entity_sentiment = args[:extract_entity_sentiment] if args.key?(:extract_entity_sentiment) diff --git a/generated/google/apis/language_v1/representations.rb b/generated/google/apis/language_v1/representations.rb index 6be38542f..0a702323a 100644 --- a/generated/google/apis/language_v1/representations.rb +++ b/generated/google/apis/language_v1/representations.rb @@ -82,6 +82,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ClassificationCategory + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ClassifyTextRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ClassifyTextResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class DependencyEdge class Representation < Google::Apis::Core::JsonRepresentation; end @@ -238,6 +256,8 @@ module Google class AnnotateTextResponse # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :categories, as: 'categories', class: Google::Apis::LanguageV1::ClassificationCategory, decorator: Google::Apis::LanguageV1::ClassificationCategory::Representation + property :document_sentiment, as: 'documentSentiment', class: Google::Apis::LanguageV1::Sentiment, decorator: Google::Apis::LanguageV1::Sentiment::Representation collection :entities, as: 'entities', class: Google::Apis::LanguageV1::Entity, decorator: Google::Apis::LanguageV1::Entity::Representation @@ -250,6 +270,30 @@ module Google end end + class ClassificationCategory + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :name, as: 'name' + end + end + + class ClassifyTextRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :document, as: 'document', class: Google::Apis::LanguageV1::Document, decorator: Google::Apis::LanguageV1::Document::Representation + + end + end + + class ClassifyTextResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :categories, as: 'categories', class: Google::Apis::LanguageV1::ClassificationCategory, decorator: Google::Apis::LanguageV1::ClassificationCategory::Representation + + end + end + class DependencyEdge # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -296,6 +340,7 @@ module Google class Features # @private class Representation < Google::Apis::Core::JsonRepresentation + property :classify_text, as: 'classifyText' property :extract_document_sentiment, as: 'extractDocumentSentiment' property :extract_entities, as: 'extractEntities' property :extract_entity_sentiment, as: 'extractEntitySentiment' diff --git a/generated/google/apis/language_v1/service.rb b/generated/google/apis/language_v1/service.rb index b5370d707..80cc11977 100644 --- a/generated/google/apis/language_v1/service.rb +++ b/generated/google/apis/language_v1/service.rb @@ -204,6 +204,36 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end + + # Classifies a document into categories. + # @param [Google::Apis::LanguageV1::ClassifyTextRequest] classify_text_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LanguageV1::ClassifyTextResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LanguageV1::ClassifyTextResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def classify_document_text(classify_text_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/documents:classifyText', options) + command.request_representation = Google::Apis::LanguageV1::ClassifyTextRequest::Representation + command.request_object = classify_text_request_object + command.response_representation = Google::Apis::LanguageV1::ClassifyTextResponse::Representation + command.response_class = Google::Apis::LanguageV1::ClassifyTextResponse + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end protected diff --git a/generated/google/apis/language_v1beta2.rb b/generated/google/apis/language_v1beta2.rb index 8e86f5b6c..0d05d7fa0 100644 --- a/generated/google/apis/language_v1beta2.rb +++ b/generated/google/apis/language_v1beta2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/natural-language/ module LanguageV1beta2 VERSION = 'V1beta2' - REVISION = '20170911' + REVISION = '20171031' # Apply machine learning models to reveal the structure and meaning of text AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language' diff --git a/generated/google/apis/language_v1beta2/classes.rb b/generated/google/apis/language_v1beta2/classes.rb index db3d3a29e..ea54b7baf 100644 --- a/generated/google/apis/language_v1beta2/classes.rb +++ b/generated/google/apis/language_v1beta2/classes.rb @@ -579,7 +579,9 @@ module Google class Features include Google::Apis::Core::Hashable - # Classify the full document into categories. + # Classify the full document into categories. If this is true, + # the API will use the default model which classifies into a + # [predefined taxonomy](/natural-language/docs/categories). # Corresponds to the JSON property `classifyText` # @return [Boolean] attr_accessor :classify_text diff --git a/generated/google/apis/logging_v2.rb b/generated/google/apis/logging_v2.rb index 1a6b25b1f..c86266a8c 100644 --- a/generated/google/apis/logging_v2.rb +++ b/generated/google/apis/logging_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/logging/docs/ module LoggingV2 VERSION = 'V2' - REVISION = '20171002' + REVISION = '20171113' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/logging_v2/classes.rb b/generated/google/apis/logging_v2/classes.rb index 473989f0f..689eeefac 100644 --- a/generated/google/apis/logging_v2/classes.rb +++ b/generated/google/apis/logging_v2/classes.rb @@ -685,6 +685,14 @@ module Google # @return [Google::Apis::LoggingV2::LogEntrySourceLocation] attr_accessor :source_location + # Optional. The span ID within the trace associated with the log entry. For + # Stackdriver Trace spans, this is the same format that the Stackdriver Trace + # API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as < + # code>"000000000000004a". + # Corresponds to the JSON property `spanId` + # @return [String] + attr_accessor :span_id + # The log entry payload, represented as a Unicode string (UTF-8). # Corresponds to the JSON property `textPayload` # @return [String] @@ -725,6 +733,7 @@ module Google @resource = args[:resource] if args.key?(:resource) @severity = args[:severity] if args.key?(:severity) @source_location = args[:source_location] if args.key?(:source_location) + @span_id = args[:span_id] if args.key?(:span_id) @text_payload = args[:text_payload] if args.key?(:text_payload) @timestamp = args[:timestamp] if args.key?(:timestamp) @trace = args[:trace] if args.key?(:trace) diff --git a/generated/google/apis/logging_v2/representations.rb b/generated/google/apis/logging_v2/representations.rb index 761fefba2..48db709ce 100644 --- a/generated/google/apis/logging_v2/representations.rb +++ b/generated/google/apis/logging_v2/representations.rb @@ -352,6 +352,7 @@ module Google property :severity, as: 'severity' property :source_location, as: 'sourceLocation', class: Google::Apis::LoggingV2::LogEntrySourceLocation, decorator: Google::Apis::LoggingV2::LogEntrySourceLocation::Representation + property :span_id, as: 'spanId' property :text_payload, as: 'textPayload' property :timestamp, as: 'timestamp' property :trace, as: 'trace' diff --git a/generated/google/apis/logging_v2/service.rb b/generated/google/apis/logging_v2/service.rb index 4da17bcfb..e0bfcb5ab 100644 --- a/generated/google/apis/logging_v2/service.rb +++ b/generated/google/apis/logging_v2/service.rb @@ -690,6 +690,207 @@ module Google execute_or_queue_command(command, &block) end + # Creates a new exclusion in a specified parent resource. Only log entries + # belonging to that resource can be excluded. You can have up to 10 exclusions + # in a resource. + # @param [String] parent + # Required. The parent resource in which to create the exclusion: + # "projects/[PROJECT_ID]" + # "organizations/[ORGANIZATION_ID]" + # "billingAccounts/[BILLING_ACCOUNT_ID]" + # "folders/[FOLDER_ID]" + # Examples: "projects/my-logging-project", "organizations/123456789". + # @param [Google::Apis::LoggingV2::LogExclusion] log_exclusion_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2::LogExclusion] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2::LogExclusion] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_exclusion(parent, log_exclusion_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2/{+parent}/exclusions', options) + command.request_representation = Google::Apis::LoggingV2::LogExclusion::Representation + command.request_object = log_exclusion_object + command.response_representation = Google::Apis::LoggingV2::LogExclusion::Representation + command.response_class = Google::Apis::LoggingV2::LogExclusion + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an exclusion. + # @param [String] name + # Required. The resource name of an existing exclusion to delete: + # "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" + # "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" + # "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" + # "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" + # Example: "projects/my-project-id/exclusions/my-exclusion-id". + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_exclusion(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v2/{+name}', options) + command.response_representation = Google::Apis::LoggingV2::Empty::Representation + command.response_class = Google::Apis::LoggingV2::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the description of an exclusion. + # @param [String] name + # Required. The resource name of an existing exclusion: + # "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" + # "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" + # "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" + # "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" + # Example: "projects/my-project-id/exclusions/my-exclusion-id". + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2::LogExclusion] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2::LogExclusion] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_exclusion(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/{+name}', options) + command.response_representation = Google::Apis::LoggingV2::LogExclusion::Representation + command.response_class = Google::Apis::LoggingV2::LogExclusion + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists all the exclusions in a parent resource. + # @param [String] parent + # Required. The parent resource whose exclusions are to be listed. + # "projects/[PROJECT_ID]" + # "organizations/[ORGANIZATION_ID]" + # "billingAccounts/[BILLING_ACCOUNT_ID]" + # "folders/[FOLDER_ID]" + # @param [Fixnum] page_size + # Optional. The maximum number of results to return from this request. Non- + # positive values are ignored. The presence of nextPageToken in the response + # indicates that more results might be available. + # @param [String] page_token + # Optional. If present, then retrieve the next batch of results from the + # preceding call to this method. pageToken must be the value of nextPageToken + # from the previous response. The values of other method parameters should be + # identical to those in the previous call. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2::ListExclusionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2::ListExclusionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_exclusions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/{+parent}/exclusions', options) + command.response_representation = Google::Apis::LoggingV2::ListExclusionsResponse::Representation + command.response_class = Google::Apis::LoggingV2::ListExclusionsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Changes one or more properties of an existing exclusion. + # @param [String] name + # Required. The resource name of the exclusion to update: + # "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" + # "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" + # "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" + # "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" + # Example: "projects/my-project-id/exclusions/my-exclusion-id". + # @param [Google::Apis::LoggingV2::LogExclusion] log_exclusion_object + # @param [String] update_mask + # Required. A nonempty list of fields to change in the existing exclusion. New + # values for the fields are taken from the corresponding fields in the + # LogExclusion included in this request. Fields not mentioned in update_mask are + # not changed and are ignored in the request.For example, to change the filter + # and description of an exclusion, specify an update_mask of "filter,description" + # . + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2::LogExclusion] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2::LogExclusion] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_exclusion(name, log_exclusion_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v2/{+name}', options) + command.request_representation = Google::Apis::LoggingV2::LogExclusion::Representation + command.request_object = log_exclusion_object + command.response_representation = Google::Apis::LoggingV2::LogExclusion::Representation + command.response_class = Google::Apis::LoggingV2::LogExclusion + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new exclusion in a specified parent resource. Only log entries # belonging to that resource can be excluded. You can have up to 10 exclusions # in a resource. @@ -1269,6 +1470,91 @@ module Google execute_or_queue_command(command, &block) end + # Deletes all the log entries in a log. The log reappears if it receives new + # entries. Log entries written shortly before the delete operation might not be + # deleted. + # @param [String] log_name + # Required. The resource name of the log to delete: + # "projects/[PROJECT_ID]/logs/[LOG_ID]" + # "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" + # "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" + # "folders/[FOLDER_ID]/logs/[LOG_ID]" + # [LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog" + # , "organizations/1234567890/logs/cloudresourcemanager.googleapis.com% + # 2Factivity". For more information about log names, see LogEntry. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_log(log_name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v2/{+logName}', options) + command.response_representation = Google::Apis::LoggingV2::Empty::Representation + command.response_class = Google::Apis::LoggingV2::Empty + command.params['logName'] = log_name unless log_name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the logs in projects, organizations, folders, or billing accounts. Only + # logs that have entries are listed. + # @param [String] parent + # Required. The resource name that owns the logs: + # "projects/[PROJECT_ID]" + # "organizations/[ORGANIZATION_ID]" + # "billingAccounts/[BILLING_ACCOUNT_ID]" + # "folders/[FOLDER_ID]" + # @param [Fixnum] page_size + # Optional. The maximum number of results to return from this request. Non- + # positive values are ignored. The presence of nextPageToken in the response + # indicates that more results might be available. + # @param [String] page_token + # Optional. If present, then retrieve the next batch of results from the + # preceding call to this method. pageToken must be the value of nextPageToken + # from the previous response. The values of other method parameters should be + # identical to those in the previous call. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2::ListLogsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2::ListLogsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_logs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/{+parent}/logs', options) + command.response_representation = Google::Apis::LoggingV2::ListLogsResponse::Representation + command.response_class = Google::Apis::LoggingV2::ListLogsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Lists the descriptors for monitored resource types used by Stackdriver Logging. # @param [Fixnum] page_size # Optional. The maximum number of results to return from this request. Non- @@ -2640,6 +2926,237 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end + + # Creates a sink that exports specified log entries to a destination. The export + # of newly-ingested log entries begins immediately, unless the sink's + # writer_identity is not permitted to write to the destination. A sink can + # export log entries only from the resource owning the sink. + # @param [String] parent + # Required. The resource in which to create the sink: + # "projects/[PROJECT_ID]" + # "organizations/[ORGANIZATION_ID]" + # "billingAccounts/[BILLING_ACCOUNT_ID]" + # "folders/[FOLDER_ID]" + # Examples: "projects/my-logging-project", "organizations/123456789". + # @param [Google::Apis::LoggingV2::LogSink] log_sink_object + # @param [Boolean] unique_writer_identity + # Optional. Determines the kind of IAM identity returned as writer_identity in + # the new sink. If this value is omitted or set to false, and if the sink's + # parent is a project, then the value returned as writer_identity is the same + # group or service account used by Stackdriver Logging before the addition of + # writer identities to this API. The sink's destination must be in the same + # project as the sink itself.If this field is set to true, or if the sink is + # owned by a non-project resource such as an organization, then the value of + # writer_identity will be a unique service account used only for exports from + # the new sink. For more information, see writer_identity in LogSink. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2::LogSink] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2::LogSink] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_sink(parent, log_sink_object = nil, unique_writer_identity: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v2/{+parent}/sinks', options) + command.request_representation = Google::Apis::LoggingV2::LogSink::Representation + command.request_object = log_sink_object + command.response_representation = Google::Apis::LoggingV2::LogSink::Representation + command.response_class = Google::Apis::LoggingV2::LogSink + command.params['parent'] = parent unless parent.nil? + command.query['uniqueWriterIdentity'] = unique_writer_identity unless unique_writer_identity.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a sink. If the sink has a unique writer_identity, then that service + # account is also deleted. + # @param [String] sink_name + # Required. The full resource name of the sink to delete, including the parent + # resource and the sink identifier: + # "projects/[PROJECT_ID]/sinks/[SINK_ID]" + # "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" + # "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" + # "folders/[FOLDER_ID]/sinks/[SINK_ID]" + # Example: "projects/my-project-id/sinks/my-sink-id". + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_sink(sink_name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v2/{+sinkName}', options) + command.response_representation = Google::Apis::LoggingV2::Empty::Representation + command.response_class = Google::Apis::LoggingV2::Empty + command.params['sinkName'] = sink_name unless sink_name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a sink. + # @param [String] sink_name + # Required. The resource name of the sink: + # "projects/[PROJECT_ID]/sinks/[SINK_ID]" + # "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" + # "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" + # "folders/[FOLDER_ID]/sinks/[SINK_ID]" + # Example: "projects/my-project-id/sinks/my-sink-id". + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2::LogSink] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2::LogSink] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_sink(sink_name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/{+sinkName}', options) + command.response_representation = Google::Apis::LoggingV2::LogSink::Representation + command.response_class = Google::Apis::LoggingV2::LogSink + command.params['sinkName'] = sink_name unless sink_name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists sinks. + # @param [String] parent + # Required. The parent resource whose sinks are to be listed: + # "projects/[PROJECT_ID]" + # "organizations/[ORGANIZATION_ID]" + # "billingAccounts/[BILLING_ACCOUNT_ID]" + # "folders/[FOLDER_ID]" + # @param [Fixnum] page_size + # Optional. The maximum number of results to return from this request. Non- + # positive values are ignored. The presence of nextPageToken in the response + # indicates that more results might be available. + # @param [String] page_token + # Optional. If present, then retrieve the next batch of results from the + # preceding call to this method. pageToken must be the value of nextPageToken + # from the previous response. The values of other method parameters should be + # identical to those in the previous call. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2::ListSinksResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2::ListSinksResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_sinks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v2/{+parent}/sinks', options) + command.response_representation = Google::Apis::LoggingV2::ListSinksResponse::Representation + command.response_class = Google::Apis::LoggingV2::ListSinksResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a sink. This method replaces the following fields in the existing sink + # with values from the new sink: destination, and filter. The updated sink might + # also have a new writer_identity; see the unique_writer_identity field. + # @param [String] sink_name + # Required. The full resource name of the sink to update, including the parent + # resource and the sink identifier: + # "projects/[PROJECT_ID]/sinks/[SINK_ID]" + # "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" + # "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" + # "folders/[FOLDER_ID]/sinks/[SINK_ID]" + # Example: "projects/my-project-id/sinks/my-sink-id". + # @param [Google::Apis::LoggingV2::LogSink] log_sink_object + # @param [Boolean] unique_writer_identity + # Optional. See sinks.create for a description of this field. When updating a + # sink, the effect of this field on the value of writer_identity in the updated + # sink depends on both the old and new values of this field: + # If the old and new values of this field are both false or both true, then + # there is no change to the sink's writer_identity. + # If the old value is false and the new value is true, then writer_identity is + # changed to a unique service account. + # It is an error if the old value is true and the new value is set to false or + # defaulted to false. + # @param [String] update_mask + # Optional. Field mask that specifies the fields in sink that need an update. A + # sink field will be overwritten if, and only if, it is in the update mask. name + # and output only fields cannot be updated.An empty updateMask is temporarily + # treated as using the following mask for backwards compatibility purposes: + # destination,filter,includeChildren At some point in the future, behavior will + # be removed and specifying an empty updateMask will be an error.For a detailed + # FieldMask definition, see https://developers.google.com/protocol-buffers/docs/ + # reference/google.protobuf#fieldmaskExample: updateMask=filter. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LoggingV2::LogSink] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LoggingV2::LogSink] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_sink(sink_name, log_sink_object = nil, unique_writer_identity: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v2/{+sinkName}', options) + command.request_representation = Google::Apis::LoggingV2::LogSink::Representation + command.request_object = log_sink_object + command.response_representation = Google::Apis::LoggingV2::LogSink::Representation + command.response_class = Google::Apis::LoggingV2::LogSink + command.params['sinkName'] = sink_name unless sink_name.nil? + command.query['uniqueWriterIdentity'] = unique_writer_identity unless unique_writer_identity.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end protected diff --git a/generated/google/apis/logging_v2beta1.rb b/generated/google/apis/logging_v2beta1.rb index d6b236a2f..2bdc30fbb 100644 --- a/generated/google/apis/logging_v2beta1.rb +++ b/generated/google/apis/logging_v2beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/logging/docs/ module LoggingV2beta1 VERSION = 'V2beta1' - REVISION = '20171002' + REVISION = '20171113' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/logging_v2beta1/classes.rb b/generated/google/apis/logging_v2beta1/classes.rb index 6063e7a49..fd26d24aa 100644 --- a/generated/google/apis/logging_v2beta1/classes.rb +++ b/generated/google/apis/logging_v2beta1/classes.rb @@ -658,6 +658,14 @@ module Google # @return [Google::Apis::LoggingV2beta1::LogEntrySourceLocation] attr_accessor :source_location + # Optional. The span ID within the trace associated with the log entry. For + # Stackdriver Trace spans, this is the same format that the Stackdriver Trace + # API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as < + # code>"000000000000004a". + # Corresponds to the JSON property `spanId` + # @return [String] + attr_accessor :span_id + # The log entry payload, represented as a Unicode string (UTF-8). # Corresponds to the JSON property `textPayload` # @return [String] @@ -698,6 +706,7 @@ module Google @resource = args[:resource] if args.key?(:resource) @severity = args[:severity] if args.key?(:severity) @source_location = args[:source_location] if args.key?(:source_location) + @span_id = args[:span_id] if args.key?(:span_id) @text_payload = args[:text_payload] if args.key?(:text_payload) @timestamp = args[:timestamp] if args.key?(:timestamp) @trace = args[:trace] if args.key?(:trace) diff --git a/generated/google/apis/logging_v2beta1/representations.rb b/generated/google/apis/logging_v2beta1/representations.rb index ae400d8e5..81b1b6448 100644 --- a/generated/google/apis/logging_v2beta1/representations.rb +++ b/generated/google/apis/logging_v2beta1/representations.rb @@ -331,6 +331,7 @@ module Google property :severity, as: 'severity' property :source_location, as: 'sourceLocation', class: Google::Apis::LoggingV2beta1::LogEntrySourceLocation, decorator: Google::Apis::LoggingV2beta1::LogEntrySourceLocation::Representation + property :span_id, as: 'spanId' property :text_payload, as: 'textPayload' property :timestamp, as: 'timestamp' property :trace, as: 'trace' diff --git a/generated/google/apis/manufacturers_v1.rb b/generated/google/apis/manufacturers_v1.rb index 6ced34ff2..1e390327f 100644 --- a/generated/google/apis/manufacturers_v1.rb +++ b/generated/google/apis/manufacturers_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/manufacturers/ module ManufacturersV1 VERSION = 'V1' - REVISION = '20170808' + REVISION = '20171009' # Manage your product listings for Google Manufacturer Center AUTH_MANUFACTURERCENTER = 'https://www.googleapis.com/auth/manufacturercenter' diff --git a/generated/google/apis/manufacturers_v1/classes.rb b/generated/google/apis/manufacturers_v1/classes.rb index 39c1a3e26..90d7d7c9f 100644 --- a/generated/google/apis/manufacturers_v1/classes.rb +++ b/generated/google/apis/manufacturers_v1/classes.rb @@ -159,7 +159,7 @@ module Google # @return [String] attr_accessor :product_page_url - # The category of the product. For more information, see + # The type or category of the product. For more information, see # https://support.google.com/manufacturers/answer/6124116#producttype. # Corresponds to the JSON property `productType` # @return [Array] @@ -200,11 +200,11 @@ module Google # @return [Google::Apis::ManufacturersV1::Price] attr_accessor :suggested_retail_price - # The target account id. Should only be used in the accounts of the data + # The target client id. Should only be used in the accounts of the data # partners. - # Corresponds to the JSON property `targetAccountId` - # @return [Fixnum] - attr_accessor :target_account_id + # Corresponds to the JSON property `targetClientId` + # @return [String] + attr_accessor :target_client_id # The theme of the product. For more information, see # https://support.google.com/manufacturers/answer/6124116#theme. @@ -259,7 +259,7 @@ module Google @size_system = args[:size_system] if args.key?(:size_system) @size_type = args[:size_type] if args.key?(:size_type) @suggested_retail_price = args[:suggested_retail_price] if args.key?(:suggested_retail_price) - @target_account_id = args[:target_account_id] if args.key?(:target_account_id) + @target_client_id = args[:target_client_id] if args.key?(:target_client_id) @theme = args[:theme] if args.key?(:theme) @title = args[:title] if args.key?(:title) @video_link = args[:video_link] if args.key?(:video_link) diff --git a/generated/google/apis/manufacturers_v1/representations.rb b/generated/google/apis/manufacturers_v1/representations.rb index 532ee7eb9..d0c09bd14 100644 --- a/generated/google/apis/manufacturers_v1/representations.rb +++ b/generated/google/apis/manufacturers_v1/representations.rb @@ -127,7 +127,7 @@ module Google property :size_type, as: 'sizeType' property :suggested_retail_price, as: 'suggestedRetailPrice', class: Google::Apis::ManufacturersV1::Price, decorator: Google::Apis::ManufacturersV1::Price::Representation - property :target_account_id, :numeric_string => true, as: 'targetAccountId' + property :target_client_id, as: 'targetClientId' property :theme, as: 'theme' property :title, as: 'title' collection :video_link, as: 'videoLink' diff --git a/generated/google/apis/ml_v1.rb b/generated/google/apis/ml_v1.rb index 9e8f2699a..4c7b24dcd 100644 --- a/generated/google/apis/ml_v1.rb +++ b/generated/google/apis/ml_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/ml/ module MlV1 VERSION = 'V1' - REVISION = '20170928' + REVISION = '20171105' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/ml_v1/classes.rb b/generated/google/apis/ml_v1/classes.rb index 65c6b210c..ab6051d3f 100644 --- a/generated/google/apis/ml_v1/classes.rb +++ b/generated/google/apis/ml_v1/classes.rb @@ -279,7 +279,6 @@ module Google end # Represents a training or prediction job. - # Next ID: 16 class GoogleCloudMlV1Job include Google::Apis::Core::Hashable @@ -298,11 +297,32 @@ module Google # @return [String] attr_accessor :error_message + # `etag` is used for optimistic concurrency control as a way to help + # prevent simultaneous updates of a job from overwriting each other. + # It is strongly suggested that systems make use of the `etag` in the + # read-modify-write cycle to perform job updates in order to avoid race + # conditions: An `etag` is returned in the response to `GetJob`, and + # systems are expected to put that etag in the request to `UpdateJob` to + # ensure that their change will be applied to the same version of the job. + # Corresponds to the JSON property `etag` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :etag + # Required. The user-specified id of the job. # Corresponds to the JSON property `jobId` # @return [String] attr_accessor :job_id + # Optional. One or more labels that you can add, to organize your jobs. + # Each label is a key-value pair, where both the key and the value are + # arbitrary strings that you supply. + # For more information, see the documentation on + # using labels. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + # Represents input parameters for a prediction job. # Corresponds to the JSON property `predictionInput` # @return [Google::Apis::MlV1::GoogleCloudMlV1PredictionInput] @@ -342,7 +362,9 @@ module Google @create_time = args[:create_time] if args.key?(:create_time) @end_time = args[:end_time] if args.key?(:end_time) @error_message = args[:error_message] if args.key?(:error_message) + @etag = args[:etag] if args.key?(:etag) @job_id = args[:job_id] if args.key?(:job_id) + @labels = args[:labels] if args.key?(:labels) @prediction_input = args[:prediction_input] if args.key?(:prediction_input) @prediction_output = args[:prediction_output] if args.key?(:prediction_output) @start_time = args[:start_time] if args.key?(:start_time) @@ -456,7 +478,6 @@ module Google # A model can have multiple versions, each of which is a deployed, trained # model ready to receive prediction requests. The model itself is just a # container. - # Next ID: 8 class GoogleCloudMlV1Model include Google::Apis::Core::Hashable @@ -466,7 +487,6 @@ module Google # information about all of the versions of a given model by calling # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models. # versions/list). - # Next ID: 19 # LINT.IfChange # Corresponds to the JSON property `defaultVersion` # @return [Google::Apis::MlV1::GoogleCloudMlV1Version] @@ -477,6 +497,27 @@ module Google # @return [String] attr_accessor :description + # `etag` is used for optimistic concurrency control as a way to help + # prevent simultaneous updates of a model from overwriting each other. + # It is strongly suggested that systems make use of the `etag` in the + # read-modify-write cycle to perform model updates in order to avoid race + # conditions: An `etag` is returned in the response to `GetModel`, and + # systems are expected to put that etag in the request to `UpdateModel` to + # ensure that their change will be applied to the model as intended. + # Corresponds to the JSON property `etag` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :etag + + # Optional. One or more labels that you can add, to organize your models. + # Each label is a key-value pair, where both the key and the value are + # arbitrary strings that you supply. + # For more information, see the documentation on + # using labels. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + # Required. The name specified for the model when it was created. # The model name must be unique within the project it is created in. # Corresponds to the JSON property `name` @@ -511,6 +552,8 @@ module Google def update!(**args) @default_version = args[:default_version] if args.key?(:default_version) @description = args[:description] if args.key?(:description) + @etag = args[:etag] if args.key?(:etag) + @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @online_prediction_logging = args[:online_prediction_logging] if args.key?(:online_prediction_logging) @regions = args[:regions] if args.key?(:regions) @@ -518,7 +561,6 @@ module Google end # Represents the metadata of the long-running operation. - # Next ID: 9 class GoogleCloudMlV1OperationMetadata include Google::Apis::Core::Hashable @@ -538,6 +580,12 @@ module Google attr_accessor :is_cancellation_requested alias_method :is_cancellation_requested?, :is_cancellation_requested + # The user labels, inherited from the model or the model version being + # operated on. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + # Contains the name of the model associated with the operation. # Corresponds to the JSON property `modelName` # @return [String] @@ -559,7 +607,6 @@ module Google # information about all of the versions of a given model by calling # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models. # versions/list). - # Next ID: 19 # LINT.IfChange # Corresponds to the JSON property `version` # @return [Google::Apis::MlV1::GoogleCloudMlV1Version] @@ -574,6 +621,7 @@ module Google @create_time = args[:create_time] if args.key?(:create_time) @end_time = args[:end_time] if args.key?(:end_time) @is_cancellation_requested = args[:is_cancellation_requested] if args.key?(:is_cancellation_requested) + @labels = args[:labels] if args.key?(:labels) @model_name = args[:model_name] if args.key?(:model_name) @operation_type = args[:operation_type] if args.key?(:operation_type) @start_time = args[:start_time] if args.key?(:start_time) @@ -1066,15 +1114,34 @@ module Google #
standard_gpu
#
# A machine equivalent to standard that - # also includes a + # also includes a single NVIDIA Tesla K80 GPU. See more about # - # GPU that you can use in your trainer. + # using GPUs for training your model. #
#
complex_model_m_gpu
#
# A machine equivalent to # complex_model_m that also includes - # four GPUs. + # four NVIDIA Tesla K80 GPUs. + #
+ #
complex_model_l_gpu
+ #
+ # A machine equivalent to + # complex_model_l that also includes + # eight NVIDIA Tesla K80 GPUs. + #
+ #
standard_p100
+ #
+ # A machine equivalent to standard that + # also includes a single NVIDIA Tesla P100 GPU. The availability of these + # GPUs is in the Alpha launch stage. + #
+ #
complex_model_m_p100
+ #
+ # A machine equivalent to + # complex_model_m that also includes + # four NVIDIA Tesla P100 GPUs. The availability of these GPUs is in + # the Alpha launch stage. #
# # You must set this value when `scaleTier` is set to `CUSTOM`. @@ -1216,7 +1283,6 @@ module Google # information about all of the versions of a given model by calling # [projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models. # versions/list). - # Next ID: 19 # LINT.IfChange class GoogleCloudMlV1Version include Google::Apis::Core::Hashable @@ -1257,6 +1323,18 @@ module Google # @return [String] attr_accessor :error_message + # `etag` is used for optimistic concurrency control as a way to help + # prevent simultaneous updates of a model from overwriting each other. + # It is strongly suggested that systems make use of the `etag` in the + # read-modify-write cycle to perform model updates in order to avoid race + # conditions: An `etag` is returned in the response to `GetVersion`, and + # systems are expected to put that etag in the request to `UpdateVersion` to + # ensure that their change will be applied to the model as intended. + # Corresponds to the JSON property `etag` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :etag + # Output only. If true, this version will be used to handle prediction # requests that do not specify a version. # You can change the default version by calling @@ -1267,6 +1345,15 @@ module Google attr_accessor :is_default alias_method :is_default?, :is_default + # Optional. One or more labels that you can add, to organize your model + # versions. Each label is a key-value pair, where both the key and the value + # are arbitrary strings that you supply. + # For more information, see the documentation on + # using labels. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + # Output only. The time the version was last used for prediction. # Corresponds to the JSON property `lastUseTime` # @return [String] @@ -1305,7 +1392,9 @@ module Google @deployment_uri = args[:deployment_uri] if args.key?(:deployment_uri) @description = args[:description] if args.key?(:description) @error_message = args[:error_message] if args.key?(:error_message) + @etag = args[:etag] if args.key?(:etag) @is_default = args[:is_default] if args.key?(:is_default) + @labels = args[:labels] if args.key?(:labels) @last_use_time = args[:last_use_time] if args.key?(:last_use_time) @manual_scaling = args[:manual_scaling] if args.key?(:manual_scaling) @name = args[:name] if args.key?(:name) diff --git a/generated/google/apis/ml_v1/representations.rb b/generated/google/apis/ml_v1/representations.rb index e02ce1135..9874035f1 100644 --- a/generated/google/apis/ml_v1/representations.rb +++ b/generated/google/apis/ml_v1/representations.rb @@ -294,7 +294,9 @@ module Google property :create_time, as: 'createTime' property :end_time, as: 'endTime' property :error_message, as: 'errorMessage' + property :etag, :base64 => true, as: 'etag' property :job_id, as: 'jobId' + hash :labels, as: 'labels' property :prediction_input, as: 'predictionInput', class: Google::Apis::MlV1::GoogleCloudMlV1PredictionInput, decorator: Google::Apis::MlV1::GoogleCloudMlV1PredictionInput::Representation property :prediction_output, as: 'predictionOutput', class: Google::Apis::MlV1::GoogleCloudMlV1PredictionOutput, decorator: Google::Apis::MlV1::GoogleCloudMlV1PredictionOutput::Representation @@ -348,6 +350,8 @@ module Google property :default_version, as: 'defaultVersion', class: Google::Apis::MlV1::GoogleCloudMlV1Version, decorator: Google::Apis::MlV1::GoogleCloudMlV1Version::Representation property :description, as: 'description' + property :etag, :base64 => true, as: 'etag' + hash :labels, as: 'labels' property :name, as: 'name' property :online_prediction_logging, as: 'onlinePredictionLogging' collection :regions, as: 'regions' @@ -360,6 +364,7 @@ module Google property :create_time, as: 'createTime' property :end_time, as: 'endTime' property :is_cancellation_requested, as: 'isCancellationRequested' + hash :labels, as: 'labels' property :model_name, as: 'modelName' property :operation_type, as: 'operationType' property :start_time, as: 'startTime' @@ -461,7 +466,9 @@ module Google property :deployment_uri, as: 'deploymentUri' property :description, as: 'description' property :error_message, as: 'errorMessage' + property :etag, :base64 => true, as: 'etag' property :is_default, as: 'isDefault' + hash :labels, as: 'labels' property :last_use_time, as: 'lastUseTime' property :manual_scaling, as: 'manualScaling', class: Google::Apis::MlV1::GoogleCloudMlV1ManualScaling, decorator: Google::Apis::MlV1::GoogleCloudMlV1ManualScaling::Representation diff --git a/generated/google/apis/ml_v1/service.rb b/generated/google/apis/ml_v1/service.rb index 305684bc6..b4bbb8791 100644 --- a/generated/google/apis/ml_v1/service.rb +++ b/generated/google/apis/ml_v1/service.rb @@ -288,6 +288,59 @@ module Google execute_or_queue_command(command, &block) end + # Updates a specific job resource. + # Currently the only supported fields to update are `labels`. + # @param [String] name + # Required. The job name. + # @param [Google::Apis::MlV1::GoogleCloudMlV1Job] google_cloud_ml_v1__job_object + # @param [String] update_mask + # Required. Specifies the path, relative to `Job`, of the field to update. + # To adopt etag mechanism, include `etag` field in the mask, and include the + # `etag` value in your job resource. + # For example, to change the labels of a job, the `update_mask` parameter + # would be specified as `labels`, `etag`, and the + # `PATCH` request body would specify the new value, as follows: + # ` + # "labels": ` + # "owner": "Google", + # "color": "Blue" + # ` + # "etag": "33a64df551425fcc55e4d42a148795d9f25f89d4" + # ` + # If `etag` matches the one on the server, the labels of the job will be + # replaced with the given ones, and the server end `etag` will be + # recalculated. + # Currently the only supported update masks are `labels` and `etag`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MlV1::GoogleCloudMlV1Job] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MlV1::GoogleCloudMlV1Job] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_job(name, google_cloud_ml_v1__job_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::MlV1::GoogleCloudMlV1Job::Representation + command.request_object = google_cloud_ml_v1__job_object + command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1Job::Representation + command.response_class = Google::Apis::MlV1::GoogleCloudMlV1Job + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Sets the access control policy on the specified resource. Replaces any # existing policy. # @param [String] resource @@ -503,6 +556,8 @@ module Google # versions. # @param [String] parent # Required. The name of the project whose models are to be listed. + # @param [String] filter + # Optional. Specifies the subset of models to retrieve. # @param [Fixnum] page_size # Optional. The number of models to retrieve per "page" of results. If there # are more remaining results than this number, the response message will @@ -529,11 +584,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_project_models(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/models', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1ListModelsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1ListModelsResponse command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? @@ -786,6 +842,8 @@ module Google # be retrieved in batches (called pages): # @param [String] parent # Required. The name of the model for which to list the version. + # @param [String] filter + # Optional. Specifies the subset of versions to retrieve. # @param [Fixnum] page_size # Optional. The number of versions to retrieve per "page" of results. If # there are more remaining results than this number, the response message @@ -812,11 +870,12 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_model_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_project_model_versions(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/versions', options) command.response_representation = Google::Apis::MlV1::GoogleCloudMlV1ListVersionsResponse::Representation command.response_class = Google::Apis::MlV1::GoogleCloudMlV1ListVersionsResponse command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? diff --git a/generated/google/apis/monitoring_v3.rb b/generated/google/apis/monitoring_v3.rb index c61446742..227667995 100644 --- a/generated/google/apis/monitoring_v3.rb +++ b/generated/google/apis/monitoring_v3.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/monitoring/api/ module MonitoringV3 VERSION = 'V3' - REVISION = '20171001' + REVISION = '20171113' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/monitoring_v3/classes.rb b/generated/google/apis/monitoring_v3/classes.rb index 273c5bc3b..015f6c3ce 100644 --- a/generated/google/apis/monitoring_v3/classes.rb +++ b/generated/google/apis/monitoring_v3/classes.rb @@ -22,6 +22,33 @@ module Google module Apis module MonitoringV3 + # A type of authentication to perform against the specified resource or URL that + # uses username and password. Currently, only Basic authentication is supported + # in Uptime Monitoring. + class BasicAuthentication + include Google::Apis::Core::Hashable + + # The password to authenticate. + # Corresponds to the JSON property `password` + # @return [String] + attr_accessor :password + + # The username to authenticate. + # Corresponds to the JSON property `username` + # @return [String] + attr_accessor :username + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @password = args[:password] if args.key?(:password) + @username = args[:username] if args.key?(:username) + end + end + # BucketOptions describes the bucket boundaries used to create a histogram for # the distribution. The buckets can be in a linear sequence, an exponential # sequence, or each bucket can be specified explicitly. BucketOptions does not @@ -300,6 +327,27 @@ module Google end end + # Used to perform string matching. Currently, this matches on the exact content. + # In the future, it can be expanded to allow for regular expressions and more + # complex matching. + class ContentMatcher + include Google::Apis::Core::Hashable + + # String content to match + # Corresponds to the JSON property `content` + # @return [String] + attr_accessor :content + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content = args[:content] if args.key?(:content) + end + end + # The CreateCollectdTimeSeries request. class CreateCollectdTimeSeriesRequest include Google::Apis::Core::Hashable @@ -698,6 +746,116 @@ module Google end end + # Information involved in an HTTP/HTTPS uptime check request. + class HttpCheck + include Google::Apis::Core::Hashable + + # A type of authentication to perform against the specified resource or URL that + # uses username and password. Currently, only Basic authentication is supported + # in Uptime Monitoring. + # Corresponds to the JSON property `authInfo` + # @return [Google::Apis::MonitoringV3::BasicAuthentication] + attr_accessor :auth_info + + # The list of headers to send as part of the uptime check request. If two + # headers have the same key and different values, they should be entered as a + # single header, with the value being a comma-separated list of all the desired + # values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page + # 31). Entering two separate headers with the same key in a Create call will + # cause the first to be overwritten by the second. + # Corresponds to the JSON property `headers` + # @return [Hash] + attr_accessor :headers + + # Boolean specifiying whether to encrypt the header information. Encryption + # should be specified for any headers related to authentication that you do not + # wish to be seen when retrieving the configuration. The server will be + # responsible for encrypting the headers. On Get/List calls, if mask_headers is + # set to True then the headers will be obscured with ******. + # Corresponds to the JSON property `maskHeaders` + # @return [Boolean] + attr_accessor :mask_headers + alias_method :mask_headers?, :mask_headers + + # The path to the page to run the check against. Will be combined with the host ( + # specified within the MonitoredResource) and port to construct the full URL. + # Optional (defaults to "/"). + # Corresponds to the JSON property `path` + # @return [String] + attr_accessor :path + + # The port to the page to run the check against. Will be combined with host ( + # specified within the MonitoredResource) and path to construct the full URL. + # Optional (defaults to 80 without SSL, or 443 with SSL). + # Corresponds to the JSON property `port` + # @return [Fixnum] + attr_accessor :port + + # If true, use HTTPS instead of HTTP to run the check. + # Corresponds to the JSON property `useSsl` + # @return [Boolean] + attr_accessor :use_ssl + alias_method :use_ssl?, :use_ssl + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @auth_info = args[:auth_info] if args.key?(:auth_info) + @headers = args[:headers] if args.key?(:headers) + @mask_headers = args[:mask_headers] if args.key?(:mask_headers) + @path = args[:path] if args.key?(:path) + @port = args[:port] if args.key?(:port) + @use_ssl = args[:use_ssl] if args.key?(:use_ssl) + end + end + + # Nimbus InternalCheckers. + class InternalChecker + include Google::Apis::Core::Hashable + + # The checker ID. + # Corresponds to the JSON property `checkerId` + # @return [String] + attr_accessor :checker_id + + # The checker's human-readable name. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The GCP zone the uptime check should egress from. Only respected for internal + # uptime checks, where internal_network is specified. + # Corresponds to the JSON property `gcpZone` + # @return [String] + attr_accessor :gcp_zone + + # The internal network to perform this uptime check on. + # Corresponds to the JSON property `network` + # @return [String] + attr_accessor :network + + # The GCP project ID. Not necessarily the same as the project_id for the config. + # Corresponds to the JSON property `projectId` + # @return [String] + attr_accessor :project_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @checker_id = args[:checker_id] if args.key?(:checker_id) + @display_name = args[:display_name] if args.key?(:display_name) + @gcp_zone = args[:gcp_zone] if args.key?(:gcp_zone) + @network = args[:network] if args.key?(:network) + @project_id = args[:project_id] if args.key?(:project_id) + end + end + # A description of a label. class LabelDescriptor include Google::Apis::Core::Hashable @@ -908,6 +1066,65 @@ module Google end end + # The protocol for the ListUptimeCheckConfigs response. + class ListUptimeCheckConfigsResponse + include Google::Apis::Core::Hashable + + # This field represents the pagination token to retrieve the next page of + # results. If the value is empty, it means no further results for the request. + # To retrieve the next page of results, the value of the next_page_token is + # passed to the subsequent List method call (in the request message's page_token + # field). + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The returned uptime check configurations. + # Corresponds to the JSON property `uptimeCheckConfigs` + # @return [Array] + attr_accessor :uptime_check_configs + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @uptime_check_configs = args[:uptime_check_configs] if args.key?(:uptime_check_configs) + end + end + + # The protocol for the ListUptimeCheckIps response. + class ListUptimeCheckIpsResponse + include Google::Apis::Core::Hashable + + # This field represents the pagination token to retrieve the next page of + # results. If the value is empty, it means no further results for the request. + # To retrieve the next page of results, the value of the next_page_token is + # passed to the subsequent List method call (in the request message's page_token + # field). NOTE: this field is not yet implemented + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The returned list of IP addresses (including region and location) that the + # checkers run from. + # Corresponds to the JSON property `uptimeCheckIps` + # @return [Array] + attr_accessor :uptime_check_ips + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @uptime_check_ips = args[:uptime_check_ips] if args.key?(:uptime_check_ips) + end + end + # A specific metric, identified by specifying values for all of the labels of a # MetricDescriptor. class Metric @@ -984,52 +1201,11 @@ module Google # @return [String] attr_accessor :type - # The unit in which the metric value is reported. It is only applicable if the - # value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset - # of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) - # standard:Basic units (UNIT) - # bit bit - # By byte - # s second - # min minute - # h hour - # d dayPrefixes (PREFIX) - # k kilo (10**3) - # M mega (10**6) - # G giga (10**9) - # T tera (10**12) - # P peta (10**15) - # E exa (10**18) - # Z zetta (10**21) - # Y yotta (10**24) - # m milli (10**-3) - # u micro (10**-6) - # n nano (10**-9) - # p pico (10**-12) - # f femto (10**-15) - # a atto (10**-18) - # z zepto (10**-21) - # y yocto (10**-24) - # Ki kibi (2**10) - # Mi mebi (2**20) - # Gi gibi (2**30) - # Ti tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/ - # s.The grammar also includes these connectors: - # / division (as an infix operator, e.g. 1/s). - # . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is - # as follows: - # Expression = Component ` "." Component ` ` "/" Component ` ; - # Component = [ PREFIX ] UNIT [ Annotation ] - # | Annotation - # | "1" - # ; - # Annotation = "`" NAME "`" ; - # Notes: - # Annotation is just a comment if it follows a UNIT and is equivalent to 1 if - # it is used alone. For examples, `requests`/s == 1/s, By`transmitted`/s == By/ - # s. - # NAME is a sequence of non-blank printable ASCII characters not containing '`' - # or '`'. + # Optional. The unit in which the metric value is reported. For example, kBy/s + # means kilobytes/sec, and 1 is the dimensionless unit. The supported units are + # a subset of The Unified Code for Units of Measure standard (http:// + # unitsofmeasure.org/ucum.html).

This field is part of the metric's + # documentation, but it is ignored by Stackdriver. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit @@ -1242,6 +1418,33 @@ module Google end end + # The resource submessage for group checks. It can be used instead of a + # monitored resource, when multiple resources are being monitored. + class ResourceGroup + include Google::Apis::Core::Hashable + + # The group of resources being monitored. Should be only the group_id, not + # projects//groups/. + # Corresponds to the JSON property `groupId` + # @return [String] + attr_accessor :group_id + + # The resource type of the group members. + # Corresponds to the JSON property `resourceType` + # @return [String] + attr_accessor :resource_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @group_id = args[:group_id] if args.key?(:group_id) + @resource_type = args[:resource_type] if args.key?(:resource_type) + end + end + # SourceContext represents information about the source of a protobuf element, # like the file in which it is defined. class SourceContext @@ -1330,6 +1533,26 @@ module Google end end + # Information required for a TCP uptime check request. + class TcpCheck + include Google::Apis::Core::Hashable + + # The port to the page to run the check against. Will be combined with host ( + # specified within the MonitoredResource) to construct the full URL. Required. + # Corresponds to the JSON property `port` + # @return [Fixnum] + attr_accessor :port + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @port = args[:port] if args.key?(:port) + end + end + # A time interval extending just after a start time through an end time. If the # start time is the same as the end time, then the interval represents a single # point in time. @@ -1536,6 +1759,150 @@ module Google @string_value = args[:string_value] if args.key?(:string_value) end end + + # This message configures which resources and services to monitor for + # availability. + class UptimeCheckConfig + include Google::Apis::Core::Hashable + + # The expected content on the page the check is run against. Currently, only the + # first entry in the list is supported, and other entries will be ignored. The + # server will look for an exact match of the string in the page response's + # content. This field is optional and should only be specified if a content + # match is required. + # Corresponds to the JSON property `contentMatchers` + # @return [Array] + attr_accessor :content_matchers + + # A human-friendly name for the uptime check configuration. The display name + # should be unique within a Stackdriver Account in order to make it easier to + # identify; however, uniqueness is not enforced. Required. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Information involved in an HTTP/HTTPS uptime check request. + # Corresponds to the JSON property `httpCheck` + # @return [Google::Apis::MonitoringV3::HttpCheck] + attr_accessor :http_check + + # The internal checkers that this check will egress from. + # Corresponds to the JSON property `internalCheckers` + # @return [Array] + attr_accessor :internal_checkers + + # An object representing a resource that can be used for monitoring, logging, + # billing, or other purposes. Examples include virtual machine instances, + # databases, and storage devices such as disks. The type field identifies a + # MonitoredResourceDescriptor object that describes the resource's schema. + # Information in the labels field identifies the actual resource and its + # attributes according to the schema. For example, a particular Compute Engine + # VM instance could be represented by the following object, because the + # MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and " + # zone": + # ` "type": "gce_instance", + # "labels": ` "instance_id": "12345678901234", + # "zone": "us-central1-a" `` + # Corresponds to the JSON property `monitoredResource` + # @return [Google::Apis::MonitoringV3::MonitoredResource] + attr_accessor :monitored_resource + + # A unique resource name for this UptimeCheckConfig. The format is:projects/[ + # PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted + # when creating the uptime check configuration; on create, the resource name is + # assigned by the server and included in the response. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # How often the uptime check is performed. Currently, only 1, 5, 10, and 15 + # minutes are supported. Required. + # Corresponds to the JSON property `period` + # @return [String] + attr_accessor :period + + # The resource submessage for group checks. It can be used instead of a + # monitored resource, when multiple resources are being monitored. + # Corresponds to the JSON property `resourceGroup` + # @return [Google::Apis::MonitoringV3::ResourceGroup] + attr_accessor :resource_group + + # The list of regions from which the check will be run. If this field is + # specified, enough regions to include a minimum of 3 locations must be provided, + # or an error message is returned. Not specifying this field will result in + # uptime checks running from all regions. + # Corresponds to the JSON property `selectedRegions` + # @return [Array] + attr_accessor :selected_regions + + # Information required for a TCP uptime check request. + # Corresponds to the JSON property `tcpCheck` + # @return [Google::Apis::MonitoringV3::TcpCheck] + attr_accessor :tcp_check + + # The maximum amount of time to wait for the request to complete (must be + # between 1 and 60 seconds). Required. + # Corresponds to the JSON property `timeout` + # @return [String] + attr_accessor :timeout + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_matchers = args[:content_matchers] if args.key?(:content_matchers) + @display_name = args[:display_name] if args.key?(:display_name) + @http_check = args[:http_check] if args.key?(:http_check) + @internal_checkers = args[:internal_checkers] if args.key?(:internal_checkers) + @monitored_resource = args[:monitored_resource] if args.key?(:monitored_resource) + @name = args[:name] if args.key?(:name) + @period = args[:period] if args.key?(:period) + @resource_group = args[:resource_group] if args.key?(:resource_group) + @selected_regions = args[:selected_regions] if args.key?(:selected_regions) + @tcp_check = args[:tcp_check] if args.key?(:tcp_check) + @timeout = args[:timeout] if args.key?(:timeout) + end + end + + # Contains the region, location, and list of IP addresses where checkers in the + # location run from. + class UptimeCheckIp + include Google::Apis::Core::Hashable + + # The IP address from which the uptime check originates. This is a full IP + # address (not an IP address range). Most IP addresses, as of this publication, + # are in IPv4 format; however, one should not rely on the IP addresses being in + # IPv4 format indefinitely and should support interpreting this field in either + # IPv4 or IPv6 format. + # Corresponds to the JSON property `ipAddress` + # @return [String] + attr_accessor :ip_address + + # A more specific location within the region that typically encodes a particular + # city/town/metro (and its containing state/province or country) within the + # broader umbrella region category. + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + # A broad region category in which the IP address is located. + # Corresponds to the JSON property `region` + # @return [String] + attr_accessor :region + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ip_address = args[:ip_address] if args.key?(:ip_address) + @location = args[:location] if args.key?(:location) + @region = args[:region] if args.key?(:region) + end + end end end end diff --git a/generated/google/apis/monitoring_v3/representations.rb b/generated/google/apis/monitoring_v3/representations.rb index e12e9c1e3..ca72fb8a8 100644 --- a/generated/google/apis/monitoring_v3/representations.rb +++ b/generated/google/apis/monitoring_v3/representations.rb @@ -22,6 +22,12 @@ module Google module Apis module MonitoringV3 + class BasicAuthentication + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class BucketOptions class Representation < Google::Apis::Core::JsonRepresentation; end @@ -52,6 +58,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ContentMatcher + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CreateCollectdTimeSeriesRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -106,6 +118,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class HttpCheck + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InternalChecker + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class LabelDescriptor class Representation < Google::Apis::Core::JsonRepresentation; end @@ -148,6 +172,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ListUptimeCheckConfigsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListUptimeCheckIpsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Metric class Representation < Google::Apis::Core::JsonRepresentation; end @@ -190,6 +226,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ResourceGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SourceContext class Representation < Google::Apis::Core::JsonRepresentation; end @@ -202,6 +244,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class TcpCheck + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class TimeInterval class Representation < Google::Apis::Core::JsonRepresentation; end @@ -226,6 +274,26 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class UptimeCheckConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UptimeCheckIp + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BasicAuthentication + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :password, as: 'password' + property :username, as: 'username' + end + end + class BucketOptions # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -284,6 +352,13 @@ module Google end end + class ContentMatcher + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content, as: 'content' + end + end + class CreateCollectdTimeSeriesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -375,6 +450,30 @@ module Google end end + class HttpCheck + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :auth_info, as: 'authInfo', class: Google::Apis::MonitoringV3::BasicAuthentication, decorator: Google::Apis::MonitoringV3::BasicAuthentication::Representation + + hash :headers, as: 'headers' + property :mask_headers, as: 'maskHeaders' + property :path, as: 'path' + property :port, as: 'port' + property :use_ssl, as: 'useSsl' + end + end + + class InternalChecker + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :checker_id, as: 'checkerId' + property :display_name, as: 'displayName' + property :gcp_zone, as: 'gcpZone' + property :network, as: 'network' + property :project_id, as: 'projectId' + end + end + class LabelDescriptor # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -439,6 +538,24 @@ module Google end end + class ListUptimeCheckConfigsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :uptime_check_configs, as: 'uptimeCheckConfigs', class: Google::Apis::MonitoringV3::UptimeCheckConfig, decorator: Google::Apis::MonitoringV3::UptimeCheckConfig::Representation + + end + end + + class ListUptimeCheckIpsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :uptime_check_ips, as: 'uptimeCheckIps', class: Google::Apis::MonitoringV3::UptimeCheckIp, decorator: Google::Apis::MonitoringV3::UptimeCheckIp::Representation + + end + end + class Metric # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -508,6 +625,14 @@ module Google end end + class ResourceGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :group_id, as: 'groupId' + property :resource_type, as: 'resourceType' + end + end + class SourceContext # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -524,6 +649,13 @@ module Google end end + class TcpCheck + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :port, as: 'port' + end + end + class TimeInterval # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -572,6 +704,38 @@ module Google property :string_value, as: 'stringValue' end end + + class UptimeCheckConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :content_matchers, as: 'contentMatchers', class: Google::Apis::MonitoringV3::ContentMatcher, decorator: Google::Apis::MonitoringV3::ContentMatcher::Representation + + property :display_name, as: 'displayName' + property :http_check, as: 'httpCheck', class: Google::Apis::MonitoringV3::HttpCheck, decorator: Google::Apis::MonitoringV3::HttpCheck::Representation + + collection :internal_checkers, as: 'internalCheckers', class: Google::Apis::MonitoringV3::InternalChecker, decorator: Google::Apis::MonitoringV3::InternalChecker::Representation + + property :monitored_resource, as: 'monitoredResource', class: Google::Apis::MonitoringV3::MonitoredResource, decorator: Google::Apis::MonitoringV3::MonitoredResource::Representation + + property :name, as: 'name' + property :period, as: 'period' + property :resource_group, as: 'resourceGroup', class: Google::Apis::MonitoringV3::ResourceGroup, decorator: Google::Apis::MonitoringV3::ResourceGroup::Representation + + collection :selected_regions, as: 'selectedRegions' + property :tcp_check, as: 'tcpCheck', class: Google::Apis::MonitoringV3::TcpCheck, decorator: Google::Apis::MonitoringV3::TcpCheck::Representation + + property :timeout, as: 'timeout' + end + end + + class UptimeCheckIp + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ip_address, as: 'ipAddress' + property :location, as: 'location' + property :region, as: 'region' + end + end end end end diff --git a/generated/google/apis/monitoring_v3/service.rb b/generated/google/apis/monitoring_v3/service.rb index 9f73e83ec..78706a3b2 100644 --- a/generated/google/apis/monitoring_v3/service.rb +++ b/generated/google/apis/monitoring_v3/service.rb @@ -694,6 +694,231 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end + + # Creates a new uptime check configuration. + # @param [String] parent + # The project in which to create the uptime check. The format is:projects/[ + # PROJECT_ID]. + # @param [Google::Apis::MonitoringV3::UptimeCheckConfig] uptime_check_config_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MonitoringV3::UptimeCheckConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MonitoringV3::UptimeCheckConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_uptime_check_config(parent, uptime_check_config_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3/{+parent}/uptimeCheckConfigs', options) + command.request_representation = Google::Apis::MonitoringV3::UptimeCheckConfig::Representation + command.request_object = uptime_check_config_object + command.response_representation = Google::Apis::MonitoringV3::UptimeCheckConfig::Representation + command.response_class = Google::Apis::MonitoringV3::UptimeCheckConfig + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an uptime check configuration. Note that this method will fail if the + # uptime check configuration is referenced by an alert policy or other dependent + # configs that would be rendered invalid by the deletion. + # @param [String] name + # The uptime check configuration to delete. The format isprojects/[PROJECT_ID]/ + # uptimeCheckConfigs/[UPTIME_CHECK_ID]. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MonitoringV3::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MonitoringV3::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_uptime_check_config(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v3/{+name}', options) + command.response_representation = Google::Apis::MonitoringV3::Empty::Representation + command.response_class = Google::Apis::MonitoringV3::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a single uptime check configuration. + # @param [String] name + # The uptime check configuration to retrieve. The format isprojects/[PROJECT_ID]/ + # uptimeCheckConfigs/[UPTIME_CHECK_ID]. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MonitoringV3::UptimeCheckConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MonitoringV3::UptimeCheckConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_uptime_check_config(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/{+name}', options) + command.response_representation = Google::Apis::MonitoringV3::UptimeCheckConfig::Representation + command.response_class = Google::Apis::MonitoringV3::UptimeCheckConfig + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists the existing valid uptime check configurations for the project, leaving + # out any invalid configurations. + # @param [String] parent + # The project whose uptime check configurations are listed. The format + # isprojects/[PROJECT_ID]. + # @param [Fixnum] page_size + # The maximum number of results to return in a single response. The server may + # further constrain the maximum number of results returned in a single page. If + # the page_size is <=0, the server will decide the number of results to be + # returned. + # @param [String] page_token + # If this field is not empty then it must contain the nextPageToken value + # returned by a previous call to this method. Using this field causes the method + # to return more results from the previous method call. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MonitoringV3::ListUptimeCheckConfigsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MonitoringV3::ListUptimeCheckConfigsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_uptime_check_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/{+parent}/uptimeCheckConfigs', options) + command.response_representation = Google::Apis::MonitoringV3::ListUptimeCheckConfigsResponse::Representation + command.response_class = Google::Apis::MonitoringV3::ListUptimeCheckConfigsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an uptime check configuration. You can either replace the entire + # configuration with a new one or replace only certain fields in the current + # configuration by specifying the fields to be updated via "updateMask". Returns + # the updated configuration. + # @param [String] name + # A unique resource name for this UptimeCheckConfig. The format is:projects/[ + # PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted + # when creating the uptime check configuration; on create, the resource name is + # assigned by the server and included in the response. + # @param [Google::Apis::MonitoringV3::UptimeCheckConfig] uptime_check_config_object + # @param [String] update_mask + # Optional. If present, only the listed fields in the current uptime check + # configuration are updated with values from the new configuration. If this + # field is empty, then the current configuration is completely replaced with the + # new configuration. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MonitoringV3::UptimeCheckConfig] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MonitoringV3::UptimeCheckConfig] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_project_uptime_check_config(name, uptime_check_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v3/{+name}', options) + command.request_representation = Google::Apis::MonitoringV3::UptimeCheckConfig::Representation + command.request_object = uptime_check_config_object + command.response_representation = Google::Apis::MonitoringV3::UptimeCheckConfig::Representation + command.response_class = Google::Apis::MonitoringV3::UptimeCheckConfig + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns the list of IPs that checkers run from + # @param [Fixnum] page_size + # The maximum number of results to return in a single response. The server may + # further constrain the maximum number of results returned in a single page. If + # the page_size is <=0, the server will decide the number of results to be + # returned. NOTE: this field is not yet implemented + # @param [String] page_token + # If this field is not empty then it must contain the nextPageToken value + # returned by a previous call to this method. Using this field causes the method + # to return more results from the previous method call. NOTE: this field is not + # yet implemented + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MonitoringV3::ListUptimeCheckIpsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MonitoringV3::ListUptimeCheckIpsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_uptime_check_ips(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/uptimeCheckIps', options) + command.response_representation = Google::Apis::MonitoringV3::ListUptimeCheckIpsResponse::Representation + command.response_class = Google::Apis::MonitoringV3::ListUptimeCheckIpsResponse + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end protected diff --git a/generated/google/apis/cloudmonitoring_v2beta2.rb b/generated/google/apis/oslogin_v1.rb similarity index 58% rename from generated/google/apis/cloudmonitoring_v2beta2.rb rename to generated/google/apis/oslogin_v1.rb index 17cd37726..fa48462c6 100644 --- a/generated/google/apis/cloudmonitoring_v2beta2.rb +++ b/generated/google/apis/oslogin_v1.rb @@ -12,26 +12,26 @@ # See the License for the specific language governing permissions and # limitations under the License. -require 'google/apis/cloudmonitoring_v2beta2/service.rb' -require 'google/apis/cloudmonitoring_v2beta2/classes.rb' -require 'google/apis/cloudmonitoring_v2beta2/representations.rb' +require 'google/apis/oslogin_v1/service.rb' +require 'google/apis/oslogin_v1/classes.rb' +require 'google/apis/oslogin_v1/representations.rb' module Google module Apis - # Cloud Monitoring API + # Google Cloud OS Login API # - # Accesses Google Cloud Monitoring data. + # Manages OS login configuration for Google account users. # - # @see https://cloud.google.com/monitoring/v2beta2/ - module CloudmonitoringV2beta2 - VERSION = 'V2beta2' - REVISION = '20170501' + # @see https://cloud.google.com/compute/docs/oslogin/rest/ + module OsloginV1 + VERSION = 'V1' + REVISION = '20171120' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' - # View and write monitoring data for all of your Google and third-party Cloud and API projects - AUTH_MONITORING = 'https://www.googleapis.com/auth/monitoring' + # View and manage your Google Compute Engine resources + AUTH_COMPUTE = 'https://www.googleapis.com/auth/compute' end end end diff --git a/generated/google/apis/oslogin_v1/classes.rb b/generated/google/apis/oslogin_v1/classes.rb new file mode 100644 index 000000000..a75d153e0 --- /dev/null +++ b/generated/google/apis/oslogin_v1/classes.rb @@ -0,0 +1,207 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module OsloginV1 + + # 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); + # ` + # The JSON representation for `Empty` is empty JSON object ````. + class Empty + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # A response message for importing an SSH public key. + class ImportSshPublicKeyResponse + include Google::Apis::Core::Hashable + + # The user profile information used for logging in to a virtual machine on + # Google Compute Engine. + # Corresponds to the JSON property `loginProfile` + # @return [Google::Apis::OsloginV1::LoginProfile] + attr_accessor :login_profile + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @login_profile = args[:login_profile] if args.key?(:login_profile) + end + end + + # The user profile information used for logging in to a virtual machine on + # Google Compute Engine. + class LoginProfile + include Google::Apis::Core::Hashable + + # The primary email address that uniquely identifies the user. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The list of POSIX accounts associated with the user. + # Corresponds to the JSON property `posixAccounts` + # @return [Array] + attr_accessor :posix_accounts + + # A map from SSH public key fingerprint to the associated key object. + # Corresponds to the JSON property `sshPublicKeys` + # @return [Hash] + attr_accessor :ssh_public_keys + + # Indicates if the user is suspended. A suspended user cannot log in but + # their profile information is retained. + # Corresponds to the JSON property `suspended` + # @return [Boolean] + attr_accessor :suspended + alias_method :suspended?, :suspended + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @posix_accounts = args[:posix_accounts] if args.key?(:posix_accounts) + @ssh_public_keys = args[:ssh_public_keys] if args.key?(:ssh_public_keys) + @suspended = args[:suspended] if args.key?(:suspended) + end + end + + # The POSIX account information associated with a Google account. + class PosixAccount + include Google::Apis::Core::Hashable + + # Output only. A POSIX account identifier. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # The GECOS (user information) entry for this account. + # Corresponds to the JSON property `gecos` + # @return [String] + attr_accessor :gecos + + # The default group ID. + # Corresponds to the JSON property `gid` + # @return [Fixnum] + attr_accessor :gid + + # The path to the home directory for this account. + # Corresponds to the JSON property `homeDirectory` + # @return [String] + attr_accessor :home_directory + + # Only one POSIX account can be marked as primary. + # Corresponds to the JSON property `primary` + # @return [Boolean] + attr_accessor :primary + alias_method :primary?, :primary + + # The path to the logic shell for this account. + # Corresponds to the JSON property `shell` + # @return [String] + attr_accessor :shell + + # System identifier for which account the username or uid applies to. + # By default, the empty value is used. + # Corresponds to the JSON property `systemId` + # @return [String] + attr_accessor :system_id + + # The user ID. + # Corresponds to the JSON property `uid` + # @return [Fixnum] + attr_accessor :uid + + # The username of the POSIX account. + # Corresponds to the JSON property `username` + # @return [String] + attr_accessor :username + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @gecos = args[:gecos] if args.key?(:gecos) + @gid = args[:gid] if args.key?(:gid) + @home_directory = args[:home_directory] if args.key?(:home_directory) + @primary = args[:primary] if args.key?(:primary) + @shell = args[:shell] if args.key?(:shell) + @system_id = args[:system_id] if args.key?(:system_id) + @uid = args[:uid] if args.key?(:uid) + @username = args[:username] if args.key?(:username) + end + end + + # The SSH public key information associated with a Google account. + class SshPublicKey + include Google::Apis::Core::Hashable + + # An expiration time in microseconds since epoch. + # Corresponds to the JSON property `expirationTimeUsec` + # @return [Fixnum] + attr_accessor :expiration_time_usec + + # Output only. The SHA-256 fingerprint of the SSH public key. + # Corresponds to the JSON property `fingerprint` + # @return [String] + attr_accessor :fingerprint + + # Public key text in SSH format, defined by + # RFC4253 + # section 6.6. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @expiration_time_usec = args[:expiration_time_usec] if args.key?(:expiration_time_usec) + @fingerprint = args[:fingerprint] if args.key?(:fingerprint) + @key = args[:key] if args.key?(:key) + end + end + end + end +end diff --git a/generated/google/apis/oslogin_v1/representations.rb b/generated/google/apis/oslogin_v1/representations.rb new file mode 100644 index 000000000..d4d075a66 --- /dev/null +++ b/generated/google/apis/oslogin_v1/representations.rb @@ -0,0 +1,106 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module OsloginV1 + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImportSshPublicKeyResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LoginProfile + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PosixAccount + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SshPublicKey + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ImportSshPublicKeyResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :login_profile, as: 'loginProfile', class: Google::Apis::OsloginV1::LoginProfile, decorator: Google::Apis::OsloginV1::LoginProfile::Representation + + end + end + + class LoginProfile + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + collection :posix_accounts, as: 'posixAccounts', class: Google::Apis::OsloginV1::PosixAccount, decorator: Google::Apis::OsloginV1::PosixAccount::Representation + + hash :ssh_public_keys, as: 'sshPublicKeys', class: Google::Apis::OsloginV1::SshPublicKey, decorator: Google::Apis::OsloginV1::SshPublicKey::Representation + + property :suspended, as: 'suspended' + end + end + + class PosixAccount + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + property :gecos, as: 'gecos' + property :gid, :numeric_string => true, as: 'gid' + property :home_directory, as: 'homeDirectory' + property :primary, as: 'primary' + property :shell, as: 'shell' + property :system_id, as: 'systemId' + property :uid, :numeric_string => true, as: 'uid' + property :username, as: 'username' + end + end + + class SshPublicKey + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :expiration_time_usec, :numeric_string => true, as: 'expirationTimeUsec' + property :fingerprint, as: 'fingerprint' + property :key, as: 'key' + end + end + end + end +end diff --git a/generated/google/apis/oslogin_v1/service.rb b/generated/google/apis/oslogin_v1/service.rb new file mode 100644 index 000000000..9f349ec89 --- /dev/null +++ b/generated/google/apis/oslogin_v1/service.rb @@ -0,0 +1,263 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module OsloginV1 + # Google Cloud OS Login API + # + # Manages OS login configuration for Google account users. + # + # @example + # require 'google/apis/oslogin_v1' + # + # Oslogin = Google::Apis::OsloginV1 # Alias the module + # service = Oslogin::CloudOSLoginService.new + # + # @see https://cloud.google.com/compute/docs/oslogin/rest/ + class CloudOSLoginService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + attr_accessor :quota_user + + def initialize + super('https://oslogin.googleapis.com/', '') + @batch_path = 'batch' + end + + # Retrieves the profile information used for logging in to a virtual machine + # on Google Compute Engine. + # @param [String] name + # The unique ID for the user in format `users/`user``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsloginV1::LoginProfile] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsloginV1::LoginProfile] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_user_login_profile(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}/loginProfile', options) + command.response_representation = Google::Apis::OsloginV1::LoginProfile::Representation + command.response_class = Google::Apis::OsloginV1::LoginProfile + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Adds an SSH public key and returns the profile information. Default POSIX + # account information is set when no username and UID exist as part of the + # login profile. + # @param [String] parent + # The unique ID for the user in format `users/`user``. + # @param [Google::Apis::OsloginV1::SshPublicKey] ssh_public_key_object + # @param [String] project_id + # The project ID of the Google Cloud Platform project. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsloginV1::ImportSshPublicKeyResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsloginV1::ImportSshPublicKeyResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def import_user_ssh_public_key(parent, ssh_public_key_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}:importSshPublicKey', options) + command.request_representation = Google::Apis::OsloginV1::SshPublicKey::Representation + command.request_object = ssh_public_key_object + command.response_representation = Google::Apis::OsloginV1::ImportSshPublicKeyResponse::Representation + command.response_class = Google::Apis::OsloginV1::ImportSshPublicKeyResponse + command.params['parent'] = parent unless parent.nil? + command.query['projectId'] = project_id unless project_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a POSIX account. + # @param [String] name + # A reference to the POSIX account to update. POSIX accounts are identified + # by the project ID they are associated with. A reference to the POSIX + # account is in format `users/`user`/projects/`project``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsloginV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsloginV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_user_project(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::OsloginV1::Empty::Representation + command.response_class = Google::Apis::OsloginV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes an SSH public key. + # @param [String] name + # The fingerprint of the public key to update. Public keys are identified by + # their SHA-256 fingerprint. The fingerprint of the public key is in format + # `users/`user`/sshPublicKeys/`fingerprint``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsloginV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsloginV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_user_ssh_public_key(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::OsloginV1::Empty::Representation + command.response_class = Google::Apis::OsloginV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves an SSH public key. + # @param [String] name + # The fingerprint of the public key to retrieve. Public keys are identified + # by their SHA-256 fingerprint. The fingerprint of the public key is in + # format `users/`user`/sshPublicKeys/`fingerprint``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsloginV1::SshPublicKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsloginV1::SshPublicKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_user_ssh_public_key(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::OsloginV1::SshPublicKey::Representation + command.response_class = Google::Apis::OsloginV1::SshPublicKey + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an SSH public key and returns the profile information. This method + # supports patch semantics. + # @param [String] name + # The fingerprint of the public key to update. Public keys are identified by + # their SHA-256 fingerprint. The fingerprint of the public key is in format + # `users/`user`/sshPublicKeys/`fingerprint``. + # @param [Google::Apis::OsloginV1::SshPublicKey] ssh_public_key_object + # @param [String] update_mask + # Mask to control which fields get updated. Updates all if not present. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsloginV1::SshPublicKey] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsloginV1::SshPublicKey] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_user_ssh_public_key(name, ssh_public_key_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+name}', options) + command.request_representation = Google::Apis::OsloginV1::SshPublicKey::Representation + command.request_object = ssh_public_key_object + command.response_representation = Google::Apis::OsloginV1::SshPublicKey::Representation + command.response_class = Google::Apis::OsloginV1::SshPublicKey + command.params['name'] = name unless name.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/oslogin_v1alpha.rb b/generated/google/apis/oslogin_v1alpha.rb index 1c3a60517..0cc6261d9 100644 --- a/generated/google/apis/oslogin_v1alpha.rb +++ b/generated/google/apis/oslogin_v1alpha.rb @@ -20,12 +20,12 @@ module Google module Apis # Google Cloud OS Login API # - # Manages OS login configuration for Directory API users. + # Manages OS login configuration for Google account users. # # @see https://cloud.google.com/compute/docs/oslogin/rest/ module OsloginV1alpha VERSION = 'V1alpha' - REVISION = '20170926' + REVISION = '20171108' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/oslogin_v1alpha/classes.rb b/generated/google/apis/oslogin_v1alpha/classes.rb index a14ef457c..799b53614 100644 --- a/generated/google/apis/oslogin_v1alpha/classes.rb +++ b/generated/google/apis/oslogin_v1alpha/classes.rb @@ -45,8 +45,8 @@ module Google class ImportSshPublicKeyResponse include Google::Apis::Core::Hashable - # The Directory API profile information used for logging in to a virtual - # machine on Google Compute Engine. + # The user profile information used for logging in to a virtual machine on + # Google Compute Engine. # Corresponds to the JSON property `loginProfile` # @return [Google::Apis::OsloginV1alpha::LoginProfile] attr_accessor :login_profile @@ -61,8 +61,8 @@ module Google end end - # The Directory API profile information used for logging in to a virtual - # machine on Google Compute Engine. + # The user profile information used for logging in to a virtual machine on + # Google Compute Engine. class LoginProfile include Google::Apis::Core::Hashable @@ -100,10 +100,15 @@ module Google end end - # The POSIX account information associated with a Directory API User. + # The POSIX account information associated with a Google account. class PosixAccount include Google::Apis::Core::Hashable + # Output only. A POSIX account identifier. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + # The GECOS (user information) entry for this account. # Corresponds to the JSON property `gecos` # @return [String] @@ -152,6 +157,7 @@ module Google # Update properties of this object def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) @gecos = args[:gecos] if args.key?(:gecos) @gid = args[:gid] if args.key?(:gid) @home_directory = args[:home_directory] if args.key?(:home_directory) @@ -163,7 +169,7 @@ module Google end end - # The SSH public key information associated with a Directory API User. + # The SSH public key information associated with a Google account. class SshPublicKey include Google::Apis::Core::Hashable @@ -172,8 +178,7 @@ module Google # @return [Fixnum] attr_accessor :expiration_time_usec - # The SHA-256 fingerprint of the SSH public key. - # Output only. + # Output only. The SHA-256 fingerprint of the SSH public key. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint diff --git a/generated/google/apis/oslogin_v1alpha/representations.rb b/generated/google/apis/oslogin_v1alpha/representations.rb index de2bebae9..200645732 100644 --- a/generated/google/apis/oslogin_v1alpha/representations.rb +++ b/generated/google/apis/oslogin_v1alpha/representations.rb @@ -81,6 +81,7 @@ module Google class PosixAccount # @private class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' property :gecos, as: 'gecos' property :gid, :numeric_string => true, as: 'gid' property :home_directory, as: 'homeDirectory' diff --git a/generated/google/apis/oslogin_v1alpha/service.rb b/generated/google/apis/oslogin_v1alpha/service.rb index 4e50b745d..81c758ae2 100644 --- a/generated/google/apis/oslogin_v1alpha/service.rb +++ b/generated/google/apis/oslogin_v1alpha/service.rb @@ -22,7 +22,7 @@ module Google module OsloginV1alpha # Google Cloud OS Login API # - # Manages OS login configuration for Directory API users. + # Manages OS login configuration for Google account users. # # @example # require 'google/apis/oslogin_v1alpha' @@ -84,6 +84,8 @@ module Google # @param [String] parent # The unique ID for the user in format `users/`user``. # @param [Google::Apis::OsloginV1alpha::SshPublicKey] ssh_public_key_object + # @param [String] project_id + # The project ID of the Google Cloud Platform project. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -101,13 +103,46 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def import_user_ssh_public_key(parent, ssh_public_key_object = nil, fields: nil, quota_user: nil, options: nil, &block) + def import_user_ssh_public_key(parent, ssh_public_key_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1alpha/{+parent}:importSshPublicKey', options) command.request_representation = Google::Apis::OsloginV1alpha::SshPublicKey::Representation command.request_object = ssh_public_key_object command.response_representation = Google::Apis::OsloginV1alpha::ImportSshPublicKeyResponse::Representation command.response_class = Google::Apis::OsloginV1alpha::ImportSshPublicKeyResponse command.params['parent'] = parent unless parent.nil? + command.query['projectId'] = project_id unless project_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a POSIX account. + # @param [String] name + # A reference to the POSIX account to update. POSIX accounts are identified + # by the project ID they are associated with. A reference to the POSIX + # account is in format `users/`user`/projects/`project``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsloginV1alpha::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsloginV1alpha::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_user_project(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha/{+name}', options) + command.response_representation = Google::Apis::OsloginV1alpha::Empty::Representation + command.response_class = Google::Apis::OsloginV1alpha::Empty + command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) diff --git a/generated/google/apis/oslogin_v1beta.rb b/generated/google/apis/oslogin_v1beta.rb index 14e364fdc..d6105a80f 100644 --- a/generated/google/apis/oslogin_v1beta.rb +++ b/generated/google/apis/oslogin_v1beta.rb @@ -20,12 +20,12 @@ module Google module Apis # Google Cloud OS Login API # - # Manages OS login configuration for Directory API users. + # Manages OS login configuration for Google account users. # # @see https://cloud.google.com/compute/docs/oslogin/rest/ module OsloginV1beta VERSION = 'V1beta' - REVISION = '20170926' + REVISION = '20171108' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/oslogin_v1beta/classes.rb b/generated/google/apis/oslogin_v1beta/classes.rb index 5012f3b79..9074f68e8 100644 --- a/generated/google/apis/oslogin_v1beta/classes.rb +++ b/generated/google/apis/oslogin_v1beta/classes.rb @@ -101,10 +101,15 @@ module Google end end - # The POSIX account information associated with a Directory API User. + # The POSIX account information associated with a Google account. class PosixAccount include Google::Apis::Core::Hashable + # Output only. A POSIX account identifier. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + # The GECOS (user information) entry for this account. # Corresponds to the JSON property `gecos` # @return [String] @@ -153,6 +158,7 @@ module Google # Update properties of this object def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) @gecos = args[:gecos] if args.key?(:gecos) @gid = args[:gid] if args.key?(:gid) @home_directory = args[:home_directory] if args.key?(:home_directory) @@ -164,7 +170,7 @@ module Google end end - # The SSH public key information associated with a Directory API User. + # The SSH public key information associated with a Google account. class SshPublicKey include Google::Apis::Core::Hashable @@ -173,8 +179,7 @@ module Google # @return [Fixnum] attr_accessor :expiration_time_usec - # The SHA-256 fingerprint of the SSH public key. - # Output only. + # Output only. The SHA-256 fingerprint of the SSH public key. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint diff --git a/generated/google/apis/oslogin_v1beta/representations.rb b/generated/google/apis/oslogin_v1beta/representations.rb index b3d51fb83..a32d0e6da 100644 --- a/generated/google/apis/oslogin_v1beta/representations.rb +++ b/generated/google/apis/oslogin_v1beta/representations.rb @@ -81,6 +81,7 @@ module Google class PosixAccount # @private class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' property :gecos, as: 'gecos' property :gid, :numeric_string => true, as: 'gid' property :home_directory, as: 'homeDirectory' diff --git a/generated/google/apis/oslogin_v1beta/service.rb b/generated/google/apis/oslogin_v1beta/service.rb index ce12e9897..cbdf5784f 100644 --- a/generated/google/apis/oslogin_v1beta/service.rb +++ b/generated/google/apis/oslogin_v1beta/service.rb @@ -22,7 +22,7 @@ module Google module OsloginV1beta # Google Cloud OS Login API # - # Manages OS login configuration for Directory API users. + # Manages OS login configuration for Google account users. # # @example # require 'google/apis/oslogin_v1beta' @@ -84,6 +84,8 @@ module Google # @param [String] parent # The unique ID for the user in format `users/`user``. # @param [Google::Apis::OsloginV1beta::SshPublicKey] ssh_public_key_object + # @param [String] project_id + # The project ID of the Google Cloud Platform project. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -101,13 +103,46 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def import_user_ssh_public_key(parent, ssh_public_key_object = nil, fields: nil, quota_user: nil, options: nil, &block) + def import_user_ssh_public_key(parent, ssh_public_key_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta/{+parent}:importSshPublicKey', options) command.request_representation = Google::Apis::OsloginV1beta::SshPublicKey::Representation command.request_object = ssh_public_key_object command.response_representation = Google::Apis::OsloginV1beta::ImportSshPublicKeyResponse::Representation command.response_class = Google::Apis::OsloginV1beta::ImportSshPublicKeyResponse command.params['parent'] = parent unless parent.nil? + command.query['projectId'] = project_id unless project_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a POSIX account. + # @param [String] name + # A reference to the POSIX account to update. POSIX accounts are identified + # by the project ID they are associated with. A reference to the POSIX + # account is in format `users/`user`/projects/`project``. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::OsloginV1beta::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::OsloginV1beta::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_user_project(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta/{+name}', options) + command.response_representation = Google::Apis::OsloginV1beta::Empty::Representation + command.response_class = Google::Apis::OsloginV1beta::Empty + command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) diff --git a/generated/google/apis/partners_v2.rb b/generated/google/apis/partners_v2.rb index 930f156d6..33d37f25e 100644 --- a/generated/google/apis/partners_v2.rb +++ b/generated/google/apis/partners_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/partners/ module PartnersV2 VERSION = 'V2' - REVISION = '20170812' + REVISION = '20171031' end end end diff --git a/generated/google/apis/partners_v2/classes.rb b/generated/google/apis/partners_v2/classes.rb index 4aa4a832f..7d980d6d6 100644 --- a/generated/google/apis/partners_v2/classes.rb +++ b/generated/google/apis/partners_v2/classes.rb @@ -1064,36 +1064,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) class LatLng include Google::Apis::Core::Hashable @@ -1530,36 +1500,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # Corresponds to the JSON property `latLng` # @return [Google::Apis::PartnersV2::LatLng] attr_accessor :lat_lng @@ -2282,6 +2222,12 @@ module Google # @return [Array] attr_accessor :markets + # Whether or not to migrate the user's exam data to Academy for Ads. + # Corresponds to the JSON property `migrateToAfa` + # @return [Boolean] + attr_accessor :migrate_to_afa + alias_method :migrate_to_afa?, :migrate_to_afa + # The user's phone number. # Corresponds to the JSON property `phoneNumber` # @return [String] @@ -2315,6 +2261,7 @@ module Google @job_functions = args[:job_functions] if args.key?(:job_functions) @languages = args[:languages] if args.key?(:languages) @markets = args[:markets] if args.key?(:markets) + @migrate_to_afa = args[:migrate_to_afa] if args.key?(:migrate_to_afa) @phone_number = args[:phone_number] if args.key?(:phone_number) @primary_country_code = args[:primary_country_code] if args.key?(:primary_country_code) @profile_public = args[:profile_public] if args.key?(:profile_public) diff --git a/generated/google/apis/partners_v2/representations.rb b/generated/google/apis/partners_v2/representations.rb index ab9f50626..3cabf398f 100644 --- a/generated/google/apis/partners_v2/representations.rb +++ b/generated/google/apis/partners_v2/representations.rb @@ -907,6 +907,7 @@ module Google collection :job_functions, as: 'jobFunctions' collection :languages, as: 'languages' collection :markets, as: 'markets' + property :migrate_to_afa, as: 'migrateToAfa' property :phone_number, as: 'phoneNumber' property :primary_country_code, as: 'primaryCountryCode' property :profile_public, as: 'profilePublic' diff --git a/generated/google/apis/people_v1.rb b/generated/google/apis/people_v1.rb index 913f0cdc0..e1810521a 100644 --- a/generated/google/apis/people_v1.rb +++ b/generated/google/apis/people_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/people/ module PeopleV1 VERSION = 'V1' - REVISION = '20170909' + REVISION = '20171108' # Manage your contacts AUTH_CONTACTS = 'https://www.googleapis.com/auth/contacts' diff --git a/generated/google/apis/people_v1/classes.rb b/generated/google/apis/people_v1/classes.rb index 2a02d2789..16a5ace88 100644 --- a/generated/google/apis/people_v1/classes.rb +++ b/generated/google/apis/people_v1/classes.rb @@ -833,6 +833,7 @@ module Google end # One of the person's interests. + # **DEPRECATED** (Message will not be returned.) class Interest include Google::Apis::Core::Hashable @@ -1388,6 +1389,7 @@ module Google attr_accessor :im_clients # The person's interests. + # **DEPRECATED** (No values will be returned.) # Corresponds to the JSON property `interests` # @return [Array] attr_accessor :interests diff --git a/generated/google/apis/people_v1/service.rb b/generated/google/apis/people_v1/service.rb index b7dabfed5..1867138bb 100644 --- a/generated/google/apis/people_v1/service.rb +++ b/generated/google/apis/people_v1/service.rb @@ -375,7 +375,6 @@ module Google # * events # * genders # * imClients - # * interests # * locales # * memberships # * metadata @@ -443,7 +442,6 @@ module Google # * events # * genders # * imClients - # * interests # * locales # * memberships # * metadata @@ -529,7 +527,6 @@ module Google # * events # * genders # * imClients - # * interests # * locales # * names # * nicknames @@ -594,7 +591,6 @@ module Google # * events # * genders # * imClients - # * interests # * locales # * memberships # * metadata diff --git a/generated/google/apis/playmoviespartner_v1/classes.rb b/generated/google/apis/playmoviespartner_v1/classes.rb deleted file mode 100644 index 9fe45f6bd..000000000 --- a/generated/google/apis/playmoviespartner_v1/classes.rb +++ /dev/null @@ -1,782 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module PlaymoviespartnerV1 - - # An Avail describes the Availability Window of a specific Edit in a given - # country, which means the period Google is allowed to sell or rent the Edit. - # Avails are exposed in EMA format Version 1.6b (available at - # http://www.movielabs.com/md/avails/) - # Studios can see the Avails for the Titles they own. - # Post-production houses cannot see any Avails. - class Avail - include Google::Apis::Core::Hashable - - # Other identifier referring to the Edit, as defined by partner. - # Example: "GOOGLER_2006" - # Corresponds to the JSON property `altId` - # @return [String] - attr_accessor :alt_id - - # ID internally generated by Google to uniquely identify an Avail. - # Not part of EMA Specs. - # Corresponds to the JSON property `availId` - # @return [String] - attr_accessor :avail_id - - # Communicating an exempt category as defined by FCC regulations. - # It is not required for non-US Avails. - # Example: "1" - # Corresponds to the JSON property `captionExemption` - # @return [String] - attr_accessor :caption_exemption - - # Communicating if caption file will be delivered. - # Corresponds to the JSON property `captionIncluded` - # @return [Boolean] - attr_accessor :caption_included - alias_method :caption_included?, :caption_included - - # Title Identifier. This should be the Title Level EIDR. - # Example: "10.5240/1489-49A2-3956-4B2D-FE16-5". - # Corresponds to the JSON property `contentId` - # @return [String] - attr_accessor :content_id - - # The name of the studio that owns the Edit referred in the Avail. - # This is the equivalent of `studio_name` in other resources, but it follows - # the EMA nomenclature. - # Example: "Google Films". - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # Manifestation Identifier. This should be the Manifestation - # Level EIDR. - # Example: "10.2340/1489-49A2-3956-4B2D-FE16-7" - # Corresponds to the JSON property `encodeId` - # @return [String] - attr_accessor :encode_id - - # End of term in YYYY-MM-DD format in the timezone of the country - # of the Avail. - # "Open" if no end date is available. - # Example: "2019-02-17" - # Corresponds to the JSON property `end` - # @return [String] - attr_accessor :end - - # Other identifier referring to the episode, as defined by partner. - # Only available on TV avails. - # Example: "rs_googlers_s1_3". - # Corresponds to the JSON property `episodeAltId` - # @return [String] - attr_accessor :episode_alt_id - - # The number assigned to the episode within a season. - # Only available on TV Avails. - # Example: "3". - # Corresponds to the JSON property `episodeNumber` - # @return [String] - attr_accessor :episode_number - - # OPTIONAL.TV Only. Title used by involved parties to refer to this episode. - # Only available on TV Avails. - # Example: "Coding at Google". - # Corresponds to the JSON property `episodeTitleInternalAlias` - # @return [String] - attr_accessor :episode_title_internal_alias - - # Indicates the format profile covered by the transaction. - # Corresponds to the JSON property `formatProfile` - # @return [String] - attr_accessor :format_profile - - # Type of transaction. - # Corresponds to the JSON property `licenseType` - # @return [String] - attr_accessor :license_type - - # Name of the post-production houses that manage the Avail. - # Not part of EMA Specs. - # Corresponds to the JSON property `pphNames` - # @return [Array] - attr_accessor :pph_names - - # Type of pricing that should be applied to this Avail - # based on how the partner classify them. - # Example: "Tier", "WSP", "SRP", or "Category". - # Corresponds to the JSON property `priceType` - # @return [String] - attr_accessor :price_type - - # Value to be applied to the pricing type. - # Example: "4" or "2.99" - # Corresponds to the JSON property `priceValue` - # @return [String] - attr_accessor :price_value - - # Edit Identifier. This should be the Edit Level EIDR. - # Example: "10.2340/1489-49A2-3956-4B2D-FE16-6" - # Corresponds to the JSON property `productId` - # @return [String] - attr_accessor :product_id - - # Value representing the rating reason. - # Rating reasons should be formatted as per - # [EMA ratings spec](http://www.movielabs.com/md/ratings/) - # and comma-separated for inclusion of multiple reasons. - # Example: "L, S, V" - # Corresponds to the JSON property `ratingReason` - # @return [String] - attr_accessor :rating_reason - - # Rating system applied to the version of title within territory - # of Avail. - # Rating systems should be formatted as per - # [EMA ratings spec](http://www.movielabs.com/md/ratings/) - # Example: "MPAA" - # Corresponds to the JSON property `ratingSystem` - # @return [String] - attr_accessor :rating_system - - # Value representing the rating. - # Ratings should be formatted as per http://www.movielabs.com/md/ratings/ - # Example: "PG" - # Corresponds to the JSON property `ratingValue` - # @return [String] - attr_accessor :rating_value - - # Release date of the Title in earliest released territory. - # Typically it is just the year, but it is free-form as per EMA spec. - # Examples: "1979", "Oct 2014" - # Corresponds to the JSON property `releaseDate` - # @return [String] - attr_accessor :release_date - - # Other identifier referring to the season, as defined by partner. - # Only available on TV avails. - # Example: "rs_googlers_s1". - # Corresponds to the JSON property `seasonAltId` - # @return [String] - attr_accessor :season_alt_id - - # The number assigned to the season within a series. - # Only available on TV Avails. - # Example: "1". - # Corresponds to the JSON property `seasonNumber` - # @return [String] - attr_accessor :season_number - - # Title used by involved parties to refer to this season. - # Only available on TV Avails. - # Example: "Googlers, The". - # Corresponds to the JSON property `seasonTitleInternalAlias` - # @return [String] - attr_accessor :season_title_internal_alias - - # Other identifier referring to the series, as defined by partner. - # Only available on TV avails. - # Example: "rs_googlers". - # Corresponds to the JSON property `seriesAltId` - # @return [String] - attr_accessor :series_alt_id - - # Title used by involved parties to refer to this series. - # Only available on TV Avails. - # Example: "Googlers, The". - # Corresponds to the JSON property `seriesTitleInternalAlias` - # @return [String] - attr_accessor :series_title_internal_alias - - # Start of term in YYYY-MM-DD format in the timezone of the - # country of the Avail. - # Example: "2013-05-14". - # Corresponds to the JSON property `start` - # @return [String] - attr_accessor :start - - # Spoken language of the intended audience. - # Language shall be encoded in accordance with RFC 5646. - # Example: "fr". - # Corresponds to the JSON property `storeLanguage` - # @return [String] - attr_accessor :store_language - - # First date an Edit could be publically announced as becoming - # available at a specific future date in territory of Avail. - # *Not* the Avail start date or pre-order start date. - # Format is YYYY-MM-DD. - # Only available for pre-orders. - # Example: "2012-12-10" - # Corresponds to the JSON property `suppressionLiftDate` - # @return [String] - attr_accessor :suppression_lift_date - - # ISO 3166-1 alpha-2 country code for the country or territory - # of this Avail. - # For Avails, we use Territory in lieu of Country to comply with - # EMA specifications. - # But please note that Territory and Country identify the same thing. - # Example: "US". - # Corresponds to the JSON property `territory` - # @return [String] - attr_accessor :territory - - # Title used by involved parties to refer to this content. - # Example: "Googlers, The". - # Only available on Movie Avails. - # Corresponds to the JSON property `titleInternalAlias` - # @return [String] - attr_accessor :title_internal_alias - - # Google-generated ID identifying the video linked to this Avail, once - # delivered. - # Not part of EMA Specs. - # Example: 'gtry456_xc' - # Corresponds to the JSON property `videoId` - # @return [String] - attr_accessor :video_id - - # Work type as enumerated in EMA. - # Corresponds to the JSON property `workType` - # @return [String] - attr_accessor :work_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @alt_id = args[:alt_id] if args.key?(:alt_id) - @avail_id = args[:avail_id] if args.key?(:avail_id) - @caption_exemption = args[:caption_exemption] if args.key?(:caption_exemption) - @caption_included = args[:caption_included] if args.key?(:caption_included) - @content_id = args[:content_id] if args.key?(:content_id) - @display_name = args[:display_name] if args.key?(:display_name) - @encode_id = args[:encode_id] if args.key?(:encode_id) - @end = args[:end] if args.key?(:end) - @episode_alt_id = args[:episode_alt_id] if args.key?(:episode_alt_id) - @episode_number = args[:episode_number] if args.key?(:episode_number) - @episode_title_internal_alias = args[:episode_title_internal_alias] if args.key?(:episode_title_internal_alias) - @format_profile = args[:format_profile] if args.key?(:format_profile) - @license_type = args[:license_type] if args.key?(:license_type) - @pph_names = args[:pph_names] if args.key?(:pph_names) - @price_type = args[:price_type] if args.key?(:price_type) - @price_value = args[:price_value] if args.key?(:price_value) - @product_id = args[:product_id] if args.key?(:product_id) - @rating_reason = args[:rating_reason] if args.key?(:rating_reason) - @rating_system = args[:rating_system] if args.key?(:rating_system) - @rating_value = args[:rating_value] if args.key?(:rating_value) - @release_date = args[:release_date] if args.key?(:release_date) - @season_alt_id = args[:season_alt_id] if args.key?(:season_alt_id) - @season_number = args[:season_number] if args.key?(:season_number) - @season_title_internal_alias = args[:season_title_internal_alias] if args.key?(:season_title_internal_alias) - @series_alt_id = args[:series_alt_id] if args.key?(:series_alt_id) - @series_title_internal_alias = args[:series_title_internal_alias] if args.key?(:series_title_internal_alias) - @start = args[:start] if args.key?(:start) - @store_language = args[:store_language] if args.key?(:store_language) - @suppression_lift_date = args[:suppression_lift_date] if args.key?(:suppression_lift_date) - @territory = args[:territory] if args.key?(:territory) - @title_internal_alias = args[:title_internal_alias] if args.key?(:title_internal_alias) - @video_id = args[:video_id] if args.key?(:video_id) - @work_type = args[:work_type] if args.key?(:work_type) - end - end - - # Response to the 'ListAvails' method. - class ListAvailsResponse - include Google::Apis::Core::Hashable - - # List of Avails that match the request criteria. - # Corresponds to the JSON property `avails` - # @return [Array] - attr_accessor :avails - - # See _List methods rules_ for info about this field. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # See _List methods rules_ for more information about this field. - # Corresponds to the JSON property `totalSize` - # @return [Fixnum] - attr_accessor :total_size - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @avails = args[:avails] if args.key?(:avails) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @total_size = args[:total_size] if args.key?(:total_size) - end - end - - # Response to the 'ListOrders' method. - class ListOrdersResponse - include Google::Apis::Core::Hashable - - # See _List methods rules_ for info about this field. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # List of Orders that match the request criteria. - # Corresponds to the JSON property `orders` - # @return [Array] - attr_accessor :orders - - # See _List methods rules_ for more information about this field. - # Corresponds to the JSON property `totalSize` - # @return [Fixnum] - attr_accessor :total_size - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @orders = args[:orders] if args.key?(:orders) - @total_size = args[:total_size] if args.key?(:total_size) - end - end - - # Response to the 'ListStoreInfos' method. - class ListStoreInfosResponse - include Google::Apis::Core::Hashable - - # See 'List methods rules' for info about this field. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # List of StoreInfos that match the request criteria. - # Corresponds to the JSON property `storeInfos` - # @return [Array] - attr_accessor :store_infos - - # See _List methods rules_ for more information about this field. - # Corresponds to the JSON property `totalSize` - # @return [Fixnum] - attr_accessor :total_size - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @store_infos = args[:store_infos] if args.key?(:store_infos) - @total_size = args[:total_size] if args.key?(:total_size) - end - end - - # An Order tracks the fulfillment of an Edit when delivered using the - # legacy, non-component-based delivery. - # Each Order is uniquely identified by an `order_id`, which is generated - # by Google. - # Externally, Orders can also be identified by partners using its `custom_id` - # (when provided). - class Order - include Google::Apis::Core::Hashable - - # Timestamp when the Order was approved. - # Corresponds to the JSON property `approvedTime` - # @return [String] - attr_accessor :approved_time - - # YouTube Channel ID that should be used to fulfill the Order. - # Example: "UCRG64darCZhb". - # Corresponds to the JSON property `channelId` - # @return [String] - attr_accessor :channel_id - - # YouTube Channel Name that should be used to fulfill the Order. - # Example: "Google_channel". - # Corresponds to the JSON property `channelName` - # @return [String] - attr_accessor :channel_name - - # Countries where the Order is available, - # using the "ISO 3166-1 alpha-2" format (example: "US"). - # Corresponds to the JSON property `countries` - # @return [Array] - attr_accessor :countries - - # ID that can be used to externally identify an Order. - # This ID is provided by partners when submitting the Avails. - # Example: 'GOOGLER_2006' - # Corresponds to the JSON property `customId` - # @return [String] - attr_accessor :custom_id - - # Timestamp of the earliest start date of the Avails - # linked to this Order. - # Corresponds to the JSON property `earliestAvailStartTime` - # @return [String] - attr_accessor :earliest_avail_start_time - - # Default Episode name, - # usually in the language of the country of origin. - # Only available for TV Edits - # Example: "Googlers, The - Pilot". - # Corresponds to the JSON property `episodeName` - # @return [String] - attr_accessor :episode_name - - # Legacy Order priority, as defined by Google. - # Example: 'P0' - # Corresponds to the JSON property `legacyPriority` - # @return [String] - attr_accessor :legacy_priority - - # Default Edit name, - # usually in the language of the country of origin. - # Example: "Googlers, The". - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # A simpler representation of the priority. - # Corresponds to the JSON property `normalizedPriority` - # @return [String] - attr_accessor :normalized_priority - - # ID internally generated by Google to uniquely identify an Order. - # Example: 'abcde12_x' - # Corresponds to the JSON property `orderId` - # @return [String] - attr_accessor :order_id - - # Timestamp when the Order was created. - # Corresponds to the JSON property `orderedTime` - # @return [String] - attr_accessor :ordered_time - - # Name of the post-production house that manages the Edit ordered. - # Corresponds to the JSON property `pphName` - # @return [String] - attr_accessor :pph_name - - # Order priority, as defined by Google. - # The higher the value, the higher the priority. - # Example: 90 - # Corresponds to the JSON property `priority` - # @return [Float] - attr_accessor :priority - - # Timestamp when the Order was fulfilled. - # Corresponds to the JSON property `receivedTime` - # @return [String] - attr_accessor :received_time - - # Field explaining why an Order has been rejected. - # Example: "Trailer audio is 2ch mono, please re-deliver in stereo". - # Corresponds to the JSON property `rejectionNote` - # @return [String] - attr_accessor :rejection_note - - # Default Season name, - # usually in the language of the country of origin. - # Only available for TV Edits - # Example: "Googlers, The - A Brave New World". - # Corresponds to the JSON property `seasonName` - # @return [String] - attr_accessor :season_name - - # Default Show name, - # usually in the language of the country of origin. - # Only available for TV Edits - # Example: "Googlers, The". - # Corresponds to the JSON property `showName` - # @return [String] - attr_accessor :show_name - - # High-level status of the order. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - # Detailed status of the order - # Corresponds to the JSON property `statusDetail` - # @return [String] - attr_accessor :status_detail - - # Name of the studio that owns the Edit ordered. - # Corresponds to the JSON property `studioName` - # @return [String] - attr_accessor :studio_name - - # Type of the Edit linked to the Order. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # Google-generated ID identifying the video linked to this Order, once - # delivered. - # Example: 'gtry456_xc'. - # Corresponds to the JSON property `videoId` - # @return [String] - attr_accessor :video_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @approved_time = args[:approved_time] if args.key?(:approved_time) - @channel_id = args[:channel_id] if args.key?(:channel_id) - @channel_name = args[:channel_name] if args.key?(:channel_name) - @countries = args[:countries] if args.key?(:countries) - @custom_id = args[:custom_id] if args.key?(:custom_id) - @earliest_avail_start_time = args[:earliest_avail_start_time] if args.key?(:earliest_avail_start_time) - @episode_name = args[:episode_name] if args.key?(:episode_name) - @legacy_priority = args[:legacy_priority] if args.key?(:legacy_priority) - @name = args[:name] if args.key?(:name) - @normalized_priority = args[:normalized_priority] if args.key?(:normalized_priority) - @order_id = args[:order_id] if args.key?(:order_id) - @ordered_time = args[:ordered_time] if args.key?(:ordered_time) - @pph_name = args[:pph_name] if args.key?(:pph_name) - @priority = args[:priority] if args.key?(:priority) - @received_time = args[:received_time] if args.key?(:received_time) - @rejection_note = args[:rejection_note] if args.key?(:rejection_note) - @season_name = args[:season_name] if args.key?(:season_name) - @show_name = args[:show_name] if args.key?(:show_name) - @status = args[:status] if args.key?(:status) - @status_detail = args[:status_detail] if args.key?(:status_detail) - @studio_name = args[:studio_name] if args.key?(:studio_name) - @type = args[:type] if args.key?(:type) - @video_id = args[:video_id] if args.key?(:video_id) - end - end - - # Information about a playable sequence (video) associated with an Edit - # and available at the Google Play Store. - # Internally, each StoreInfo is uniquely identified by a `video_id` - # and `country`. - # Externally, Title-level EIDR or Edit-level EIDR, if provided, - # can also be used to identify a specific title or edit in a country. - class StoreInfo - include Google::Apis::Core::Hashable - - # Audio tracks available for this Edit. - # Corresponds to the JSON property `audioTracks` - # @return [Array] - attr_accessor :audio_tracks - - # Country where Edit is available in ISO 3166-1 alpha-2 country - # code. - # Example: "US". - # Corresponds to the JSON property `country` - # @return [String] - attr_accessor :country - - # Edit-level EIDR ID. - # Example: "10.5240/1489-49A2-3956-4B2D-FE16-6". - # Corresponds to the JSON property `editLevelEidr` - # @return [String] - attr_accessor :edit_level_eidr - - # The number assigned to the episode within a season. - # Only available on TV Edits. - # Example: "1". - # Corresponds to the JSON property `episodeNumber` - # @return [String] - attr_accessor :episode_number - - # Whether the Edit has a 5.1 channel audio track. - # Corresponds to the JSON property `hasAudio51` - # @return [Boolean] - attr_accessor :has_audio51 - alias_method :has_audio51?, :has_audio51 - - # Whether the Edit has a EST offer. - # Corresponds to the JSON property `hasEstOffer` - # @return [Boolean] - attr_accessor :has_est_offer - alias_method :has_est_offer?, :has_est_offer - - # Whether the Edit has a HD offer. - # Corresponds to the JSON property `hasHdOffer` - # @return [Boolean] - attr_accessor :has_hd_offer - alias_method :has_hd_offer?, :has_hd_offer - - # Whether the Edit has info cards. - # Corresponds to the JSON property `hasInfoCards` - # @return [Boolean] - attr_accessor :has_info_cards - alias_method :has_info_cards?, :has_info_cards - - # Whether the Edit has a SD offer. - # Corresponds to the JSON property `hasSdOffer` - # @return [Boolean] - attr_accessor :has_sd_offer - alias_method :has_sd_offer?, :has_sd_offer - - # Whether the Edit has a VOD offer. - # Corresponds to the JSON property `hasVodOffer` - # @return [Boolean] - attr_accessor :has_vod_offer - alias_method :has_vod_offer?, :has_vod_offer - - # Timestamp when the Edit went live on the Store. - # Corresponds to the JSON property `liveTime` - # @return [String] - attr_accessor :live_time - - # Knowledge Graph ID associated to this Edit, if available. - # This ID links the Edit to its knowledge entity, externally accessible - # at http://freebase.com. - # In the absense of Title EIDR or Edit EIDR, this ID helps link together - # multiple Edits across countries. - # Example: '/m/0ffx29' - # Corresponds to the JSON property `mid` - # @return [String] - attr_accessor :mid - - # Default Edit name, usually in the language of the country of - # origin. - # Example: "Googlers, The". - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Name of the post-production houses that manage the Edit. - # Corresponds to the JSON property `pphNames` - # @return [Array] - attr_accessor :pph_names - - # Google-generated ID identifying the season linked to the Edit. - # Only available for TV Edits. - # Example: 'ster23ex' - # Corresponds to the JSON property `seasonId` - # @return [String] - attr_accessor :season_id - - # Default Season name, usually in the language of the country of - # origin. - # Only available for TV Edits - # Example: "Googlers, The - A Brave New World". - # Corresponds to the JSON property `seasonName` - # @return [String] - attr_accessor :season_name - - # The number assigned to the season within a show. - # Only available on TV Edits. - # Example: "1". - # Corresponds to the JSON property `seasonNumber` - # @return [String] - attr_accessor :season_number - - # Google-generated ID identifying the show linked to the Edit. - # Only available for TV Edits. - # Example: 'et2hsue_x' - # Corresponds to the JSON property `showId` - # @return [String] - attr_accessor :show_id - - # Default Show name, usually in the language of the country of - # origin. - # Only available for TV Edits - # Example: "Googlers, The". - # Corresponds to the JSON property `showName` - # @return [String] - attr_accessor :show_name - - # Name of the studio that owns the Edit ordered. - # Corresponds to the JSON property `studioName` - # @return [String] - attr_accessor :studio_name - - # Subtitles available for this Edit. - # Corresponds to the JSON property `subtitles` - # @return [Array] - attr_accessor :subtitles - - # Title-level EIDR ID. - # Example: "10.5240/1489-49A2-3956-4B2D-FE16-5". - # Corresponds to the JSON property `titleLevelEidr` - # @return [String] - attr_accessor :title_level_eidr - - # Google-generated ID identifying the trailer linked to the Edit. - # Example: 'bhd_4e_cx' - # Corresponds to the JSON property `trailerId` - # @return [String] - attr_accessor :trailer_id - - # Edit type, like Movie, Episode or Season. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # Google-generated ID identifying the video linked to the Edit. - # Example: 'gtry456_xc' - # Corresponds to the JSON property `videoId` - # @return [String] - attr_accessor :video_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @audio_tracks = args[:audio_tracks] if args.key?(:audio_tracks) - @country = args[:country] if args.key?(:country) - @edit_level_eidr = args[:edit_level_eidr] if args.key?(:edit_level_eidr) - @episode_number = args[:episode_number] if args.key?(:episode_number) - @has_audio51 = args[:has_audio51] if args.key?(:has_audio51) - @has_est_offer = args[:has_est_offer] if args.key?(:has_est_offer) - @has_hd_offer = args[:has_hd_offer] if args.key?(:has_hd_offer) - @has_info_cards = args[:has_info_cards] if args.key?(:has_info_cards) - @has_sd_offer = args[:has_sd_offer] if args.key?(:has_sd_offer) - @has_vod_offer = args[:has_vod_offer] if args.key?(:has_vod_offer) - @live_time = args[:live_time] if args.key?(:live_time) - @mid = args[:mid] if args.key?(:mid) - @name = args[:name] if args.key?(:name) - @pph_names = args[:pph_names] if args.key?(:pph_names) - @season_id = args[:season_id] if args.key?(:season_id) - @season_name = args[:season_name] if args.key?(:season_name) - @season_number = args[:season_number] if args.key?(:season_number) - @show_id = args[:show_id] if args.key?(:show_id) - @show_name = args[:show_name] if args.key?(:show_name) - @studio_name = args[:studio_name] if args.key?(:studio_name) - @subtitles = args[:subtitles] if args.key?(:subtitles) - @title_level_eidr = args[:title_level_eidr] if args.key?(:title_level_eidr) - @trailer_id = args[:trailer_id] if args.key?(:trailer_id) - @type = args[:type] if args.key?(:type) - @video_id = args[:video_id] if args.key?(:video_id) - end - end - end - end -end diff --git a/generated/google/apis/playmoviespartner_v1/representations.rb b/generated/google/apis/playmoviespartner_v1/representations.rb deleted file mode 100644 index 42d536803..000000000 --- a/generated/google/apis/playmoviespartner_v1/representations.rb +++ /dev/null @@ -1,191 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module PlaymoviespartnerV1 - - class Avail - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListAvailsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListOrdersResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListStoreInfosResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Order - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class StoreInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Avail - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :alt_id, as: 'altId' - property :avail_id, as: 'availId' - property :caption_exemption, as: 'captionExemption' - property :caption_included, as: 'captionIncluded' - property :content_id, as: 'contentId' - property :display_name, as: 'displayName' - property :encode_id, as: 'encodeId' - property :end, as: 'end' - property :episode_alt_id, as: 'episodeAltId' - property :episode_number, as: 'episodeNumber' - property :episode_title_internal_alias, as: 'episodeTitleInternalAlias' - property :format_profile, as: 'formatProfile' - property :license_type, as: 'licenseType' - collection :pph_names, as: 'pphNames' - property :price_type, as: 'priceType' - property :price_value, as: 'priceValue' - property :product_id, as: 'productId' - property :rating_reason, as: 'ratingReason' - property :rating_system, as: 'ratingSystem' - property :rating_value, as: 'ratingValue' - property :release_date, as: 'releaseDate' - property :season_alt_id, as: 'seasonAltId' - property :season_number, as: 'seasonNumber' - property :season_title_internal_alias, as: 'seasonTitleInternalAlias' - property :series_alt_id, as: 'seriesAltId' - property :series_title_internal_alias, as: 'seriesTitleInternalAlias' - property :start, as: 'start' - property :store_language, as: 'storeLanguage' - property :suppression_lift_date, as: 'suppressionLiftDate' - property :territory, as: 'territory' - property :title_internal_alias, as: 'titleInternalAlias' - property :video_id, as: 'videoId' - property :work_type, as: 'workType' - end - end - - class ListAvailsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :avails, as: 'avails', class: Google::Apis::PlaymoviespartnerV1::Avail, decorator: Google::Apis::PlaymoviespartnerV1::Avail::Representation - - property :next_page_token, as: 'nextPageToken' - property :total_size, as: 'totalSize' - end - end - - class ListOrdersResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :orders, as: 'orders', class: Google::Apis::PlaymoviespartnerV1::Order, decorator: Google::Apis::PlaymoviespartnerV1::Order::Representation - - property :total_size, as: 'totalSize' - end - end - - class ListStoreInfosResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :store_infos, as: 'storeInfos', class: Google::Apis::PlaymoviespartnerV1::StoreInfo, decorator: Google::Apis::PlaymoviespartnerV1::StoreInfo::Representation - - property :total_size, as: 'totalSize' - end - end - - class Order - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :approved_time, as: 'approvedTime' - property :channel_id, as: 'channelId' - property :channel_name, as: 'channelName' - collection :countries, as: 'countries' - property :custom_id, as: 'customId' - property :earliest_avail_start_time, as: 'earliestAvailStartTime' - property :episode_name, as: 'episodeName' - property :legacy_priority, as: 'legacyPriority' - property :name, as: 'name' - property :normalized_priority, as: 'normalizedPriority' - property :order_id, as: 'orderId' - property :ordered_time, as: 'orderedTime' - property :pph_name, as: 'pphName' - property :priority, as: 'priority' - property :received_time, as: 'receivedTime' - property :rejection_note, as: 'rejectionNote' - property :season_name, as: 'seasonName' - property :show_name, as: 'showName' - property :status, as: 'status' - property :status_detail, as: 'statusDetail' - property :studio_name, as: 'studioName' - property :type, as: 'type' - property :video_id, as: 'videoId' - end - end - - class StoreInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :audio_tracks, as: 'audioTracks' - property :country, as: 'country' - property :edit_level_eidr, as: 'editLevelEidr' - property :episode_number, as: 'episodeNumber' - property :has_audio51, as: 'hasAudio51' - property :has_est_offer, as: 'hasEstOffer' - property :has_hd_offer, as: 'hasHdOffer' - property :has_info_cards, as: 'hasInfoCards' - property :has_sd_offer, as: 'hasSdOffer' - property :has_vod_offer, as: 'hasVodOffer' - property :live_time, as: 'liveTime' - property :mid, as: 'mid' - property :name, as: 'name' - collection :pph_names, as: 'pphNames' - property :season_id, as: 'seasonId' - property :season_name, as: 'seasonName' - property :season_number, as: 'seasonNumber' - property :show_id, as: 'showId' - property :show_name, as: 'showName' - property :studio_name, as: 'studioName' - collection :subtitles, as: 'subtitles' - property :title_level_eidr, as: 'titleLevelEidr' - property :trailer_id, as: 'trailerId' - property :type, as: 'type' - property :video_id, as: 'videoId' - end - end - end - end -end diff --git a/generated/google/apis/playmoviespartner_v1/service.rb b/generated/google/apis/playmoviespartner_v1/service.rb deleted file mode 100644 index a87545986..000000000 --- a/generated/google/apis/playmoviespartner_v1/service.rb +++ /dev/null @@ -1,354 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module PlaymoviespartnerV1 - # Google Play Movies Partner API - # - # Gets the delivery status of titles for Google Play Movies Partners. - # - # @example - # require 'google/apis/playmoviespartner_v1' - # - # Playmoviespartner = Google::Apis::PlaymoviespartnerV1 # Alias the module - # service = Playmoviespartner::PlayMoviesService.new - # - # @see https://developers.google.com/playmoviespartner/ - class PlayMoviesService < Google::Apis::Core::BaseService - # @return [String] - # 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. - attr_accessor :key - - # @return [String] - # 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. - attr_accessor :quota_user - - def initialize - super('https://playmoviespartner.googleapis.com/', '') - @batch_path = 'batch' - end - - # Get an Avail given its avail group id and avail id. - # @param [String] account_id - # REQUIRED. See _General rules_ for more information about this field. - # @param [String] avail_id - # REQUIRED. Avail ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::PlaymoviespartnerV1::Avail] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::PlaymoviespartnerV1::Avail] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_avail(account_id, avail_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/accounts/{accountId}/avails/{availId}', options) - command.response_representation = Google::Apis::PlaymoviespartnerV1::Avail::Representation - command.response_class = Google::Apis::PlaymoviespartnerV1::Avail - command.params['accountId'] = account_id unless account_id.nil? - command.params['availId'] = avail_id unless avail_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # List Avails owned or managed by the partner. - # See _Authentication and Authorization rules_ and - # _List methods rules_ for more information about this method. - # @param [String] account_id - # REQUIRED. See _General rules_ for more information about this field. - # @param [String] alt_id - # Filter Avails that match a case-insensitive, partner-specific custom id. - # NOTE: this field is deprecated and will be removed on V2; `alt_ids` - # should be used instead. - # @param [Array, String] alt_ids - # Filter Avails that match (case-insensitive) any of the given partner-specific - # custom ids. - # @param [Fixnum] page_size - # See _List methods rules_ for info about this field. - # @param [String] page_token - # See _List methods rules_ for info about this field. - # @param [Array, String] pph_names - # See _List methods rules_ for info about this field. - # @param [Array, String] studio_names - # See _List methods rules_ for info about this field. - # @param [Array, String] territories - # Filter Avails that match (case-insensitive) any of the given country codes, - # using the "ISO 3166-1 alpha-2" format (examples: "US", "us", "Us"). - # @param [String] title - # Filter that matches Avails with a `title_internal_alias`, - # `series_title_internal_alias`, `season_title_internal_alias`, - # or `episode_title_internal_alias` that contains the given - # case-insensitive title. - # @param [Array, String] video_ids - # Filter Avails that match any of the given `video_id`s. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::PlaymoviespartnerV1::ListAvailsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::PlaymoviespartnerV1::ListAvailsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_avails(account_id, alt_id: nil, alt_ids: nil, page_size: nil, page_token: nil, pph_names: nil, studio_names: nil, territories: nil, title: nil, video_ids: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/accounts/{accountId}/avails', options) - command.response_representation = Google::Apis::PlaymoviespartnerV1::ListAvailsResponse::Representation - command.response_class = Google::Apis::PlaymoviespartnerV1::ListAvailsResponse - command.params['accountId'] = account_id unless account_id.nil? - command.query['altId'] = alt_id unless alt_id.nil? - command.query['altIds'] = alt_ids unless alt_ids.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['pphNames'] = pph_names unless pph_names.nil? - command.query['studioNames'] = studio_names unless studio_names.nil? - command.query['territories'] = territories unless territories.nil? - command.query['title'] = title unless title.nil? - command.query['videoIds'] = video_ids unless video_ids.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Get an Order given its id. - # See _Authentication and Authorization rules_ and - # _Get methods rules_ for more information about this method. - # @param [String] account_id - # REQUIRED. See _General rules_ for more information about this field. - # @param [String] order_id - # REQUIRED. Order ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::PlaymoviespartnerV1::Order] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::PlaymoviespartnerV1::Order] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_order(account_id, order_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/accounts/{accountId}/orders/{orderId}', options) - command.response_representation = Google::Apis::PlaymoviespartnerV1::Order::Representation - command.response_class = Google::Apis::PlaymoviespartnerV1::Order - command.params['accountId'] = account_id unless account_id.nil? - command.params['orderId'] = order_id unless order_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # List Orders owned or managed by the partner. - # See _Authentication and Authorization rules_ and - # _List methods rules_ for more information about this method. - # @param [String] account_id - # REQUIRED. See _General rules_ for more information about this field. - # @param [String] custom_id - # Filter Orders that match a case-insensitive, partner-specific custom id. - # @param [String] name - # Filter that matches Orders with a `name`, `show`, `season` or `episode` - # that contains the given case-insensitive name. - # @param [Fixnum] page_size - # See _List methods rules_ for info about this field. - # @param [String] page_token - # See _List methods rules_ for info about this field. - # @param [Array, String] pph_names - # See _List methods rules_ for info about this field. - # @param [Array, String] status - # Filter Orders that match one of the given status. - # @param [Array, String] studio_names - # See _List methods rules_ for info about this field. - # @param [Array, String] video_ids - # Filter Orders that match any of the given `video_id`s. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::PlaymoviespartnerV1::ListOrdersResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::PlaymoviespartnerV1::ListOrdersResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_orders(account_id, custom_id: nil, name: nil, page_size: nil, page_token: nil, pph_names: nil, status: nil, studio_names: nil, video_ids: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/accounts/{accountId}/orders', options) - command.response_representation = Google::Apis::PlaymoviespartnerV1::ListOrdersResponse::Representation - command.response_class = Google::Apis::PlaymoviespartnerV1::ListOrdersResponse - command.params['accountId'] = account_id unless account_id.nil? - command.query['customId'] = custom_id unless custom_id.nil? - command.query['name'] = name unless name.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['pphNames'] = pph_names unless pph_names.nil? - command.query['status'] = status unless status.nil? - command.query['studioNames'] = studio_names unless studio_names.nil? - command.query['videoIds'] = video_ids unless video_ids.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # List StoreInfos owned or managed by the partner. - # See _Authentication and Authorization rules_ and - # _List methods rules_ for more information about this method. - # @param [String] account_id - # REQUIRED. See _General rules_ for more information about this field. - # @param [Array, String] countries - # Filter StoreInfos that match (case-insensitive) any of the given country - # codes, using the "ISO 3166-1 alpha-2" format (examples: "US", "us", "Us"). - # @param [Array, String] mids - # Filter StoreInfos that match any of the given `mid`s. - # @param [String] name - # Filter that matches StoreInfos with a `name` or `show_name` - # that contains the given case-insensitive name. - # @param [Fixnum] page_size - # See _List methods rules_ for info about this field. - # @param [String] page_token - # See _List methods rules_ for info about this field. - # @param [Array, String] pph_names - # See _List methods rules_ for info about this field. - # @param [Array, String] season_ids - # Filter StoreInfos that match any of the given `season_id`s. - # @param [Array, String] studio_names - # See _List methods rules_ for info about this field. - # @param [String] video_id - # Filter StoreInfos that match a given `video_id`. - # NOTE: this field is deprecated and will be removed on V2; `video_ids` - # should be used instead. - # @param [Array, String] video_ids - # Filter StoreInfos that match any of the given `video_id`s. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::PlaymoviespartnerV1::ListStoreInfosResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::PlaymoviespartnerV1::ListStoreInfosResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_store_infos(account_id, countries: nil, mids: nil, name: nil, page_size: nil, page_token: nil, pph_names: nil, season_ids: nil, studio_names: nil, video_id: nil, video_ids: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/accounts/{accountId}/storeInfos', options) - command.response_representation = Google::Apis::PlaymoviespartnerV1::ListStoreInfosResponse::Representation - command.response_class = Google::Apis::PlaymoviespartnerV1::ListStoreInfosResponse - command.params['accountId'] = account_id unless account_id.nil? - command.query['countries'] = countries unless countries.nil? - command.query['mids'] = mids unless mids.nil? - command.query['name'] = name unless name.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['pphNames'] = pph_names unless pph_names.nil? - command.query['seasonIds'] = season_ids unless season_ids.nil? - command.query['studioNames'] = studio_names unless studio_names.nil? - command.query['videoId'] = video_id unless video_id.nil? - command.query['videoIds'] = video_ids unless video_ids.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Get a StoreInfo given its video id and country. - # See _Authentication and Authorization rules_ and - # _Get methods rules_ for more information about this method. - # @param [String] account_id - # REQUIRED. See _General rules_ for more information about this field. - # @param [String] video_id - # REQUIRED. Video ID. - # @param [String] country - # REQUIRED. Edit country. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # 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. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::PlaymoviespartnerV1::StoreInfo] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::PlaymoviespartnerV1::StoreInfo] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_store_info_country(account_id, video_id, country, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/accounts/{accountId}/storeInfos/{videoId}/country/{country}', options) - command.response_representation = Google::Apis::PlaymoviespartnerV1::StoreInfo::Representation - command.response_class = Google::Apis::PlaymoviespartnerV1::StoreInfo - command.params['accountId'] = account_id unless account_id.nil? - command.params['videoId'] = video_id unless video_id.nil? - command.params['country'] = country unless country.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - end - end - end - end -end diff --git a/generated/google/apis/proximitybeacon_v1beta1.rb b/generated/google/apis/proximitybeacon_v1beta1.rb index 85f44631a..b4ea5cff0 100644 --- a/generated/google/apis/proximitybeacon_v1beta1.rb +++ b/generated/google/apis/proximitybeacon_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/beacons/proximity/ module ProximitybeaconV1beta1 VERSION = 'V1beta1' - REVISION = '20171003' + REVISION = '20171112' # View and modify your beacons AUTH_USERLOCATION_BEACON_REGISTRY = 'https://www.googleapis.com/auth/userlocation.beacon.registry' diff --git a/generated/google/apis/proximitybeacon_v1beta1/classes.rb b/generated/google/apis/proximitybeacon_v1beta1/classes.rb index a933a0d40..ad723a5e7 100644 --- a/generated/google/apis/proximitybeacon_v1beta1/classes.rb +++ b/generated/google/apis/proximitybeacon_v1beta1/classes.rb @@ -66,6 +66,21 @@ module Google # @return [String] attr_accessor :data + # The distance away from the beacon at which this attachment should be + # delivered to a mobile app. + # Setting this to a value greater than zero indicates that the app should + # behave as if the beacon is "seen" when the mobile device is less than this + # distance away from the beacon. + # Different attachments on the same beacon can have different max distances. + # Note that even though this value is expressed with fractional meter + # precision, real-world behavior is likley to be much less precise than one + # meter, due to the nature of current Bluetooth radio technology. + # Optional. When not set or zero, the attachment should be delivered at the + # beacon's outer limit of detection. + # Corresponds to the JSON property `maxDistanceMeters` + # @return [Float] + attr_accessor :max_distance_meters + # Specifies what kind of attachment this is. Tells a client how to # interpret the `data` field. Format is namespace/type, for # example scrupulous-wombat-12345/welcome-message @@ -80,6 +95,7 @@ module Google # Update properties of this object def update!(**args) @data = args[:data] if args.key?(:data) + @max_distance_meters = args[:max_distance_meters] if args.key?(:max_distance_meters) @namespaced_type = args[:namespaced_type] if args.key?(:namespaced_type) end end @@ -152,36 +168,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # Corresponds to the JSON property `latLng` # @return [Google::Apis::ProximitybeaconV1beta1::LatLng] attr_accessor :lat_lng @@ -662,36 +648,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) class LatLng include Google::Apis::Core::Hashable diff --git a/generated/google/apis/proximitybeacon_v1beta1/representations.rb b/generated/google/apis/proximitybeacon_v1beta1/representations.rb index a33ce9d5a..610519173 100644 --- a/generated/google/apis/proximitybeacon_v1beta1/representations.rb +++ b/generated/google/apis/proximitybeacon_v1beta1/representations.rb @@ -160,6 +160,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :data, :base64 => true, as: 'data' + property :max_distance_meters, as: 'maxDistanceMeters' property :namespaced_type, as: 'namespacedType' end end diff --git a/generated/google/apis/qpx_express_v1/classes.rb b/generated/google/apis/qpx_express_v1/classes.rb deleted file mode 100644 index 136d9afd6..000000000 --- a/generated/google/apis/qpx_express_v1/classes.rb +++ /dev/null @@ -1,1274 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module QpxExpressV1 - - # The make, model, and type of an aircraft. - class AircraftData - include Google::Apis::Core::Hashable - - # The aircraft code. For example, for a Boeing 777 the code would be 777. - # Corresponds to the JSON property `code` - # @return [String] - attr_accessor :code - - # Identifies this as an aircraftData object. Value: the fixed string qpxexpress# - # aircraftData - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The name of an aircraft, for example Boeing 777. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @code = args[:code] if args.key?(:code) - @kind = args[:kind] if args.key?(:kind) - @name = args[:name] if args.key?(:name) - end - end - - # An airport. - class AirportData - include Google::Apis::Core::Hashable - - # The city code an airport is located in. For example, for JFK airport, this is - # NYC. - # Corresponds to the JSON property `city` - # @return [String] - attr_accessor :city - - # An airport's code. For example, for Boston Logan airport, this is BOS. - # Corresponds to the JSON property `code` - # @return [String] - attr_accessor :code - - # Identifies this as an airport object. Value: the fixed string qpxexpress# - # airportData. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The name of an airport. For example, for airport BOS the name is "Boston Logan - # International". - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @city = args[:city] if args.key?(:city) - @code = args[:code] if args.key?(:code) - @kind = args[:kind] if args.key?(:kind) - @name = args[:name] if args.key?(:name) - end - end - - # Information about an item of baggage. - class BagDescriptor - include Google::Apis::Core::Hashable - - # Provides the commercial name for an optional service. - # Corresponds to the JSON property `commercialName` - # @return [String] - attr_accessor :commercial_name - - # How many of this type of bag will be checked on this flight. - # Corresponds to the JSON property `count` - # @return [Fixnum] - attr_accessor :count - - # A description of the baggage. - # Corresponds to the JSON property `description` - # @return [Array] - attr_accessor :description - - # Identifies this as a baggage object. Value: the fixed string qpxexpress# - # bagDescriptor. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The standard IATA subcode used to identify this optional service. - # Corresponds to the JSON property `subcode` - # @return [String] - attr_accessor :subcode - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @commercial_name = args[:commercial_name] if args.key?(:commercial_name) - @count = args[:count] if args.key?(:count) - @description = args[:description] if args.key?(:description) - @kind = args[:kind] if args.key?(:kind) - @subcode = args[:subcode] if args.key?(:subcode) - end - end - - # Information about a carrier (ie. an airline, bus line, railroad, etc) that - # might be useful to display to an end-user. - class CarrierData - include Google::Apis::Core::Hashable - - # The IATA designator of a carrier (airline, etc). For example, for American - # Airlines, the code is AA. - # Corresponds to the JSON property `code` - # @return [String] - attr_accessor :code - - # Identifies this as a kind of carrier (ie. an airline, bus line, railroad, etc). - # Value: the fixed string qpxexpress#carrierData. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The long, full name of a carrier. For example: American Airlines. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @code = args[:code] if args.key?(:code) - @kind = args[:kind] if args.key?(:kind) - @name = args[:name] if args.key?(:name) - end - end - - # Information about a city that might be useful to an end-user; typically the - # city of an airport. - class CityData - include Google::Apis::Core::Hashable - - # The IATA character ID of a city. For example, for Boston this is BOS. - # Corresponds to the JSON property `code` - # @return [String] - attr_accessor :code - - # The two-character country code of the country the city is located in. For - # example, US for the United States of America. - # Corresponds to the JSON property `country` - # @return [String] - attr_accessor :country - - # Identifies this as a city, typically with one or more airports. Value: the - # fixed string qpxexpress#cityData. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The full name of a city. An example would be: New York. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @code = args[:code] if args.key?(:code) - @country = args[:country] if args.key?(:country) - @kind = args[:kind] if args.key?(:kind) - @name = args[:name] if args.key?(:name) - end - end - - # Detailed information about components found in the solutions of this response, - # including a trip's airport, city, taxes, airline, and aircraft. - class Data - include Google::Apis::Core::Hashable - - # The aircraft that is flying between an origin and destination. - # Corresponds to the JSON property `aircraft` - # @return [Array] - attr_accessor :aircraft - - # The airport of an origin or destination. - # Corresponds to the JSON property `airport` - # @return [Array] - attr_accessor :airport - - # The airline carrier of the aircraft flying between an origin and destination. - # Allowed values are IATA carrier codes. - # Corresponds to the JSON property `carrier` - # @return [Array] - attr_accessor :carrier - - # The city that is either the origin or destination of part of a trip. - # Corresponds to the JSON property `city` - # @return [Array] - attr_accessor :city - - # Identifies this as QPX Express response resource, including a trip's airport, - # city, taxes, airline, and aircraft. Value: the fixed string qpxexpress#data. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The taxes due for flying between an origin and a destination. - # Corresponds to the JSON property `tax` - # @return [Array] - attr_accessor :tax - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @aircraft = args[:aircraft] if args.key?(:aircraft) - @airport = args[:airport] if args.key?(:airport) - @carrier = args[:carrier] if args.key?(:carrier) - @city = args[:city] if args.key?(:city) - @kind = args[:kind] if args.key?(:kind) - @tax = args[:tax] if args.key?(:tax) - end - end - - # Complete information about a fare used in the solution to a low-fare search - # query. In the airline industry a fare is a price an airline charges for one- - # way travel between two points. A fare typically contains a carrier code, two - # city codes, a price, and a fare basis. (A fare basis is a one-to-eight - # character alphanumeric code used to identify a fare.) - class FareInfo - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `basisCode` - # @return [String] - attr_accessor :basis_code - - # The carrier of the aircraft or other vehicle commuting between two points. - # Corresponds to the JSON property `carrier` - # @return [String] - attr_accessor :carrier - - # The city code of the city the trip ends at. - # Corresponds to the JSON property `destination` - # @return [String] - attr_accessor :destination - - # A unique identifier of the fare. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Identifies this as a fare object. Value: the fixed string qpxexpress#fareInfo. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The city code of the city the trip begins at. - # Corresponds to the JSON property `origin` - # @return [String] - attr_accessor :origin - - # Whether this is a private fare, for example one offered only to select - # customers rather than the general public. - # Corresponds to the JSON property `private` - # @return [Boolean] - attr_accessor :private - alias_method :private?, :private - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @basis_code = args[:basis_code] if args.key?(:basis_code) - @carrier = args[:carrier] if args.key?(:carrier) - @destination = args[:destination] if args.key?(:destination) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @origin = args[:origin] if args.key?(:origin) - @private = args[:private] if args.key?(:private) - end - end - - # A flight is a sequence of legs with the same airline carrier and flight number. - # (A leg is the smallest unit of travel, in the case of a flight a takeoff - # immediately followed by a landing at two set points on a particular carrier - # with a particular flight number.) The naive view is that a flight is scheduled - # travel of an aircraft between two points, with possibly intermediate stops, - # but carriers will frequently list flights that require a change of aircraft - # between legs. - class FlightInfo - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `carrier` - # @return [String] - attr_accessor :carrier - - # The flight number. - # Corresponds to the JSON property `number` - # @return [String] - attr_accessor :number - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @carrier = args[:carrier] if args.key?(:carrier) - @number = args[:number] if args.key?(:number) - end - end - - # Information about free baggage allowed on one segment of a trip. - class FreeBaggageAllowance - include Google::Apis::Core::Hashable - - # A representation of a type of bag, such as an ATPCo subcode, Commercial Name, - # or other description. - # Corresponds to the JSON property `bagDescriptor` - # @return [Array] - attr_accessor :bag_descriptor - - # The maximum number of kilos all the free baggage together may weigh. - # Corresponds to the JSON property `kilos` - # @return [Fixnum] - attr_accessor :kilos - - # The maximum number of kilos any one piece of baggage may weigh. - # Corresponds to the JSON property `kilosPerPiece` - # @return [Fixnum] - attr_accessor :kilos_per_piece - - # Identifies this as free baggage object, allowed on one segment of a trip. - # Value: the fixed string qpxexpress#freeBaggageAllowance. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The number of free pieces of baggage allowed. - # Corresponds to the JSON property `pieces` - # @return [Fixnum] - attr_accessor :pieces - - # The number of pounds of free baggage allowed. - # Corresponds to the JSON property `pounds` - # @return [Fixnum] - attr_accessor :pounds - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @bag_descriptor = args[:bag_descriptor] if args.key?(:bag_descriptor) - @kilos = args[:kilos] if args.key?(:kilos) - @kilos_per_piece = args[:kilos_per_piece] if args.key?(:kilos_per_piece) - @kind = args[:kind] if args.key?(:kind) - @pieces = args[:pieces] if args.key?(:pieces) - @pounds = args[:pounds] if args.key?(:pounds) - end - end - - # Information about a leg. (A leg is the smallest unit of travel, in the case of - # a flight a takeoff immediately followed by a landing at two set points on a - # particular carrier with a particular flight number.) - class LegInfo - include Google::Apis::Core::Hashable - - # The aircraft (or bus, ferry, railcar, etc) travelling between the two points - # of this leg. - # Corresponds to the JSON property `aircraft` - # @return [String] - attr_accessor :aircraft - - # The scheduled time of arrival at the destination of the leg, local to the - # point of arrival. - # Corresponds to the JSON property `arrivalTime` - # @return [String] - attr_accessor :arrival_time - - # Whether you have to change planes following this leg. Only applies to the next - # leg. - # Corresponds to the JSON property `changePlane` - # @return [Boolean] - attr_accessor :change_plane - alias_method :change_plane?, :change_plane - - # Duration of a connection following this leg, in minutes. - # Corresponds to the JSON property `connectionDuration` - # @return [Fixnum] - attr_accessor :connection_duration - - # The scheduled departure time of the leg, local to the point of departure. - # Corresponds to the JSON property `departureTime` - # @return [String] - attr_accessor :departure_time - - # The leg destination as a city and airport. - # Corresponds to the JSON property `destination` - # @return [String] - attr_accessor :destination - - # The terminal the flight is scheduled to arrive at. - # Corresponds to the JSON property `destinationTerminal` - # @return [String] - attr_accessor :destination_terminal - - # The scheduled travelling time from the origin to the destination. - # Corresponds to the JSON property `duration` - # @return [Fixnum] - attr_accessor :duration - - # An identifier that uniquely identifies this leg in the solution. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Identifies this as a leg object. A leg is the smallest unit of travel, in the - # case of a flight a takeoff immediately followed by a landing at two set points - # on a particular carrier with a particular flight number. Value: the fixed - # string qpxexpress#legInfo. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # A simple, general description of the meal(s) served on the flight, for example: - # "Hot meal". - # Corresponds to the JSON property `meal` - # @return [String] - attr_accessor :meal - - # The number of miles in this leg. - # Corresponds to the JSON property `mileage` - # @return [Fixnum] - attr_accessor :mileage - - # In percent, the published on time performance on this leg. - # Corresponds to the JSON property `onTimePerformance` - # @return [Fixnum] - attr_accessor :on_time_performance - - # Department of Transportation disclosure information on the actual operator of - # a flight in a code share. (A code share refers to a marketing agreement - # between two carriers, where one carrier will list in its schedules (and take - # bookings for) flights that are actually operated by another carrier.) - # Corresponds to the JSON property `operatingDisclosure` - # @return [String] - attr_accessor :operating_disclosure - - # The leg origin as a city and airport. - # Corresponds to the JSON property `origin` - # @return [String] - attr_accessor :origin - - # The terminal the flight is scheduled to depart from. - # Corresponds to the JSON property `originTerminal` - # @return [String] - attr_accessor :origin_terminal - - # Whether passenger information must be furnished to the United States - # Transportation Security Administration (TSA) prior to departure. - # Corresponds to the JSON property `secure` - # @return [Boolean] - attr_accessor :secure - alias_method :secure?, :secure - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @aircraft = args[:aircraft] if args.key?(:aircraft) - @arrival_time = args[:arrival_time] if args.key?(:arrival_time) - @change_plane = args[:change_plane] if args.key?(:change_plane) - @connection_duration = args[:connection_duration] if args.key?(:connection_duration) - @departure_time = args[:departure_time] if args.key?(:departure_time) - @destination = args[:destination] if args.key?(:destination) - @destination_terminal = args[:destination_terminal] if args.key?(:destination_terminal) - @duration = args[:duration] if args.key?(:duration) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @meal = args[:meal] if args.key?(:meal) - @mileage = args[:mileage] if args.key?(:mileage) - @on_time_performance = args[:on_time_performance] if args.key?(:on_time_performance) - @operating_disclosure = args[:operating_disclosure] if args.key?(:operating_disclosure) - @origin = args[:origin] if args.key?(:origin) - @origin_terminal = args[:origin_terminal] if args.key?(:origin_terminal) - @secure = args[:secure] if args.key?(:secure) - end - end - - # The number and type of passengers. Unfortunately the definition of an infant, - # child, adult, and senior citizen varies across carriers and reservation - # systems. - class PassengerCounts - include Google::Apis::Core::Hashable - - # The number of passengers that are adults. - # Corresponds to the JSON property `adultCount` - # @return [Fixnum] - attr_accessor :adult_count - - # The number of passengers that are children. - # Corresponds to the JSON property `childCount` - # @return [Fixnum] - attr_accessor :child_count - - # The number of passengers that are infants travelling in the lap of an adult. - # Corresponds to the JSON property `infantInLapCount` - # @return [Fixnum] - attr_accessor :infant_in_lap_count - - # The number of passengers that are infants each assigned a seat. - # Corresponds to the JSON property `infantInSeatCount` - # @return [Fixnum] - attr_accessor :infant_in_seat_count - - # Identifies this as a passenger count object, representing the number of - # passengers. Value: the fixed string qpxexpress#passengerCounts. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The number of passengers that are senior citizens. - # Corresponds to the JSON property `seniorCount` - # @return [Fixnum] - attr_accessor :senior_count - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @adult_count = args[:adult_count] if args.key?(:adult_count) - @child_count = args[:child_count] if args.key?(:child_count) - @infant_in_lap_count = args[:infant_in_lap_count] if args.key?(:infant_in_lap_count) - @infant_in_seat_count = args[:infant_in_seat_count] if args.key?(:infant_in_seat_count) - @kind = args[:kind] if args.key?(:kind) - @senior_count = args[:senior_count] if args.key?(:senior_count) - end - end - - # The price of one or more travel segments. The currency used to purchase - # tickets is usually determined by the sale/ticketing city or the sale/ticketing - # country, unless none are specified, in which case it defaults to that of the - # journey origin country. - class PricingInfo - include Google::Apis::Core::Hashable - - # The total fare in the base fare currency (the currency of the country of - # origin). This element is only present when the sales currency and the currency - # of the country of commencement are different. - # Corresponds to the JSON property `baseFareTotal` - # @return [String] - attr_accessor :base_fare_total - - # The fare used to price one or more segments. - # Corresponds to the JSON property `fare` - # @return [Array] - attr_accessor :fare - - # The horizontal fare calculation. This is a field on a ticket that displays all - # of the relevant items that go into the calculation of the fare. - # Corresponds to the JSON property `fareCalculation` - # @return [String] - attr_accessor :fare_calculation - - # Identifies this as a pricing object, representing the price of one or more - # travel segments. Value: the fixed string qpxexpress#pricingInfo. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The latest ticketing time for this pricing assuming the reservation occurs at - # ticketing time and there is no change in fares/rules. The time is local to the - # point of sale (POS). - # Corresponds to the JSON property `latestTicketingTime` - # @return [String] - attr_accessor :latest_ticketing_time - - # The number and type of passengers. Unfortunately the definition of an infant, - # child, adult, and senior citizen varies across carriers and reservation - # systems. - # Corresponds to the JSON property `passengers` - # @return [Google::Apis::QpxExpressV1::PassengerCounts] - attr_accessor :passengers - - # The passenger type code for this pricing. An alphanumeric code used by a - # carrier to restrict fares to certain categories of passenger. For instance, a - # fare might be valid only for senior citizens. - # Corresponds to the JSON property `ptc` - # @return [String] - attr_accessor :ptc - - # Whether the fares on this pricing are refundable. - # Corresponds to the JSON property `refundable` - # @return [Boolean] - attr_accessor :refundable - alias_method :refundable?, :refundable - - # The total fare in the sale or equivalent currency. - # Corresponds to the JSON property `saleFareTotal` - # @return [String] - attr_accessor :sale_fare_total - - # The taxes in the sale or equivalent currency. - # Corresponds to the JSON property `saleTaxTotal` - # @return [String] - attr_accessor :sale_tax_total - - # Total per-passenger price (fare and tax) in the sale or equivalent currency. - # Corresponds to the JSON property `saleTotal` - # @return [String] - attr_accessor :sale_total - - # The per-segment price and baggage information. - # Corresponds to the JSON property `segmentPricing` - # @return [Array] - attr_accessor :segment_pricing - - # The taxes used to calculate the tax total per ticket. - # Corresponds to the JSON property `tax` - # @return [Array] - attr_accessor :tax - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @base_fare_total = args[:base_fare_total] if args.key?(:base_fare_total) - @fare = args[:fare] if args.key?(:fare) - @fare_calculation = args[:fare_calculation] if args.key?(:fare_calculation) - @kind = args[:kind] if args.key?(:kind) - @latest_ticketing_time = args[:latest_ticketing_time] if args.key?(:latest_ticketing_time) - @passengers = args[:passengers] if args.key?(:passengers) - @ptc = args[:ptc] if args.key?(:ptc) - @refundable = args[:refundable] if args.key?(:refundable) - @sale_fare_total = args[:sale_fare_total] if args.key?(:sale_fare_total) - @sale_tax_total = args[:sale_tax_total] if args.key?(:sale_tax_total) - @sale_total = args[:sale_total] if args.key?(:sale_total) - @segment_pricing = args[:segment_pricing] if args.key?(:segment_pricing) - @tax = args[:tax] if args.key?(:tax) - end - end - - # Details of a segment of a flight; a segment is one or more consecutive legs on - # the same flight. For example a hypothetical flight ZZ001, from DFW to OGG, - # would have one segment with two legs: DFW to HNL (leg 1), HNL to OGG (leg 2), - # and DFW to OGG (legs 1 and 2). - class SegmentInfo - include Google::Apis::Core::Hashable - - # The booking code or class for this segment. - # Corresponds to the JSON property `bookingCode` - # @return [String] - attr_accessor :booking_code - - # The number of seats available in this booking code on this segment. - # Corresponds to the JSON property `bookingCodeCount` - # @return [Fixnum] - attr_accessor :booking_code_count - - # The cabin booked for this segment. - # Corresponds to the JSON property `cabin` - # @return [String] - attr_accessor :cabin - - # In minutes, the duration of the connection following this segment. - # Corresponds to the JSON property `connectionDuration` - # @return [Fixnum] - attr_accessor :connection_duration - - # The duration of the flight segment in minutes. - # Corresponds to the JSON property `duration` - # @return [Fixnum] - attr_accessor :duration - - # A flight is a sequence of legs with the same airline carrier and flight number. - # (A leg is the smallest unit of travel, in the case of a flight a takeoff - # immediately followed by a landing at two set points on a particular carrier - # with a particular flight number.) The naive view is that a flight is scheduled - # travel of an aircraft between two points, with possibly intermediate stops, - # but carriers will frequently list flights that require a change of aircraft - # between legs. - # Corresponds to the JSON property `flight` - # @return [Google::Apis::QpxExpressV1::FlightInfo] - attr_accessor :flight - - # An id uniquely identifying the segment in the solution. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Identifies this as a segment object. A segment is one or more consecutive legs - # on the same flight. For example a hypothetical flight ZZ001, from DFW to OGG, - # could have one segment with two legs: DFW to HNL (leg 1), HNL to OGG (leg 2). - # Value: the fixed string qpxexpress#segmentInfo. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The legs composing this segment. - # Corresponds to the JSON property `leg` - # @return [Array] - attr_accessor :leg - - # The solution-based index of a segment in a married segment group. Married - # segments can only be booked together. For example, an airline might report a - # certain booking code as sold out from Boston to Pittsburgh, but as available - # as part of two married segments Boston to Chicago connecting through - # Pittsburgh. For example content of this field, consider the round-trip flight - # ZZ1 PHX-PHL ZZ2 PHL-CLT ZZ3 CLT-PHX. This has three segments, with the two - # outbound ones (ZZ1 ZZ2) married. In this case, the two outbound segments - # belong to married segment group 0, and the return segment belongs to married - # segment group 1. - # Corresponds to the JSON property `marriedSegmentGroup` - # @return [String] - attr_accessor :married_segment_group - - # Whether the operation of this segment remains subject to government approval. - # Corresponds to the JSON property `subjectToGovernmentApproval` - # @return [Boolean] - attr_accessor :subject_to_government_approval - alias_method :subject_to_government_approval?, :subject_to_government_approval - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @booking_code = args[:booking_code] if args.key?(:booking_code) - @booking_code_count = args[:booking_code_count] if args.key?(:booking_code_count) - @cabin = args[:cabin] if args.key?(:cabin) - @connection_duration = args[:connection_duration] if args.key?(:connection_duration) - @duration = args[:duration] if args.key?(:duration) - @flight = args[:flight] if args.key?(:flight) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @leg = args[:leg] if args.key?(:leg) - @married_segment_group = args[:married_segment_group] if args.key?(:married_segment_group) - @subject_to_government_approval = args[:subject_to_government_approval] if args.key?(:subject_to_government_approval) - end - end - - # The price of this segment. - class SegmentPricing - include Google::Apis::Core::Hashable - - # A segment identifier unique within a single solution. It is used to refer to - # different parts of the same solution. - # Corresponds to the JSON property `fareId` - # @return [String] - attr_accessor :fare_id - - # Details of the free baggage allowance on this segment. - # Corresponds to the JSON property `freeBaggageOption` - # @return [Array] - attr_accessor :free_baggage_option - - # Identifies this as a segment pricing object, representing the price of this - # segment. Value: the fixed string qpxexpress#segmentPricing. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Unique identifier in the response of this segment. - # Corresponds to the JSON property `segmentId` - # @return [String] - attr_accessor :segment_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @fare_id = args[:fare_id] if args.key?(:fare_id) - @free_baggage_option = args[:free_baggage_option] if args.key?(:free_baggage_option) - @kind = args[:kind] if args.key?(:kind) - @segment_id = args[:segment_id] if args.key?(:segment_id) - end - end - - # Information about a slice. A slice represents a traveller's intent, the - # portion of a low-fare search corresponding to a traveler's request to get - # between two points. One-way journeys are generally expressed using 1 slice, - # round-trips using 2. For example, if a traveler specifies the following trip - # in a user interface: - # | Origin | Destination | Departure Date | | BOS | LAX | March 10, 2007 | | LAX - # | SYD | March 17, 2007 | | SYD | BOS | March 22, 2007 | - # then this is a three slice trip. - class SliceInfo - include Google::Apis::Core::Hashable - - # The duration of the slice in minutes. - # Corresponds to the JSON property `duration` - # @return [Fixnum] - attr_accessor :duration - - # Identifies this as a slice object. A slice represents a traveller's intent, - # the portion of a low-fare search corresponding to a traveler's request to get - # between two points. One-way journeys are generally expressed using 1 slice, - # round-trips using 2. Value: the fixed string qpxexpress#sliceInfo. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The segment(s) constituting the slice. - # Corresponds to the JSON property `segment` - # @return [Array] - attr_accessor :segment - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @duration = args[:duration] if args.key?(:duration) - @kind = args[:kind] if args.key?(:kind) - @segment = args[:segment] if args.key?(:segment) - end - end - - # Criteria a desired slice must satisfy. - class SliceInput - include Google::Apis::Core::Hashable - - # Slices with only the carriers in this alliance should be returned; do not use - # this field with permittedCarrier. Allowed values are ONEWORLD, SKYTEAM, and - # STAR. - # Corresponds to the JSON property `alliance` - # @return [String] - attr_accessor :alliance - - # Departure date in YYYY-MM-DD format. - # Corresponds to the JSON property `date` - # @return [String] - attr_accessor :date - - # Airport or city IATA designator of the destination. - # Corresponds to the JSON property `destination` - # @return [String] - attr_accessor :destination - - # Identifies this as a slice input object, representing the criteria a desired - # slice must satisfy. Value: the fixed string qpxexpress#sliceInput. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The longest connection between two legs, in minutes, you are willing to accept. - # Corresponds to the JSON property `maxConnectionDuration` - # @return [Fixnum] - attr_accessor :max_connection_duration - - # The maximum number of stops you are willing to accept in this slice. - # Corresponds to the JSON property `maxStops` - # @return [Fixnum] - attr_accessor :max_stops - - # Airport or city IATA designator of the origin. - # Corresponds to the JSON property `origin` - # @return [String] - attr_accessor :origin - - # A list of 2-letter IATA airline designators. Slices with only these carriers - # should be returned. - # Corresponds to the JSON property `permittedCarrier` - # @return [Array] - attr_accessor :permitted_carrier - - # Two times in a single day defining a time range. - # Corresponds to the JSON property `permittedDepartureTime` - # @return [Google::Apis::QpxExpressV1::TimeOfDayRange] - attr_accessor :permitted_departure_time - - # Prefer solutions that book in this cabin for this slice. Allowed values are - # COACH, PREMIUM_COACH, BUSINESS, and FIRST. - # Corresponds to the JSON property `preferredCabin` - # @return [String] - attr_accessor :preferred_cabin - - # A list of 2-letter IATA airline designators. Exclude slices that use these - # carriers. - # Corresponds to the JSON property `prohibitedCarrier` - # @return [Array] - attr_accessor :prohibited_carrier - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @alliance = args[:alliance] if args.key?(:alliance) - @date = args[:date] if args.key?(:date) - @destination = args[:destination] if args.key?(:destination) - @kind = args[:kind] if args.key?(:kind) - @max_connection_duration = args[:max_connection_duration] if args.key?(:max_connection_duration) - @max_stops = args[:max_stops] if args.key?(:max_stops) - @origin = args[:origin] if args.key?(:origin) - @permitted_carrier = args[:permitted_carrier] if args.key?(:permitted_carrier) - @permitted_departure_time = args[:permitted_departure_time] if args.key?(:permitted_departure_time) - @preferred_cabin = args[:preferred_cabin] if args.key?(:preferred_cabin) - @prohibited_carrier = args[:prohibited_carrier] if args.key?(:prohibited_carrier) - end - end - - # Tax data. - class TaxData - include Google::Apis::Core::Hashable - - # An identifier uniquely identifying a tax in a response. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Identifies this as a tax data object, representing some tax. Value: the fixed - # string qpxexpress#taxData. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The name of a tax. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @name = args[:name] if args.key?(:name) - end - end - - # Tax information. - class TaxInfo - include Google::Apis::Core::Hashable - - # Whether this is a government charge or a carrier surcharge. - # Corresponds to the JSON property `chargeType` - # @return [String] - attr_accessor :charge_type - - # The code to enter in the ticket's tax box. - # Corresponds to the JSON property `code` - # @return [String] - attr_accessor :code - - # For government charges, the country levying the charge. - # Corresponds to the JSON property `country` - # @return [String] - attr_accessor :country - - # Identifier uniquely identifying this tax in a response. Not present for - # unnamed carrier surcharges. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Identifies this as a tax information object. Value: the fixed string - # qpxexpress#taxInfo. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The price of the tax in the sales or equivalent currency. - # Corresponds to the JSON property `salePrice` - # @return [String] - attr_accessor :sale_price - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @charge_type = args[:charge_type] if args.key?(:charge_type) - @code = args[:code] if args.key?(:code) - @country = args[:country] if args.key?(:country) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @sale_price = args[:sale_price] if args.key?(:sale_price) - end - end - - # Two times in a single day defining a time range. - class TimeOfDayRange - include Google::Apis::Core::Hashable - - # The earliest time of day in HH:MM format. - # Corresponds to the JSON property `earliestTime` - # @return [String] - attr_accessor :earliest_time - - # Identifies this as a time of day range object, representing two times in a - # single day defining a time range. Value: the fixed string qpxexpress# - # timeOfDayRange. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The latest time of day in HH:MM format. - # Corresponds to the JSON property `latestTime` - # @return [String] - attr_accessor :latest_time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @earliest_time = args[:earliest_time] if args.key?(:earliest_time) - @kind = args[:kind] if args.key?(:kind) - @latest_time = args[:latest_time] if args.key?(:latest_time) - end - end - - # Trip information. - class TripOption - include Google::Apis::Core::Hashable - - # Identifier uniquely identifying this trip in a response. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Identifies this as a trip information object. Value: the fixed string - # qpxexpress#tripOption. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Per passenger pricing information. - # Corresponds to the JSON property `pricing` - # @return [Array] - attr_accessor :pricing - - # The total price for all passengers on the trip, in the form of a currency - # followed by an amount, e.g. USD253.35. - # Corresponds to the JSON property `saleTotal` - # @return [String] - attr_accessor :sale_total - - # The slices that make up this trip's itinerary. - # Corresponds to the JSON property `slice` - # @return [Array] - attr_accessor :slice - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @pricing = args[:pricing] if args.key?(:pricing) - @sale_total = args[:sale_total] if args.key?(:sale_total) - @slice = args[:slice] if args.key?(:slice) - end - end - - # A QPX Express search request, which will yield one or more solutions. - class TripOptionsRequest - include Google::Apis::Core::Hashable - - # Do not return solutions that cost more than this price. The alphabetical part - # of the price is in ISO 4217. The format, in regex, is [A-Z]`3`\d+(\.\d+)? - # Example: $102.07 - # Corresponds to the JSON property `maxPrice` - # @return [String] - attr_accessor :max_price - - # The number and type of passengers. Unfortunately the definition of an infant, - # child, adult, and senior citizen varies across carriers and reservation - # systems. - # Corresponds to the JSON property `passengers` - # @return [Google::Apis::QpxExpressV1::PassengerCounts] - attr_accessor :passengers - - # Return only solutions with refundable fares. - # Corresponds to the JSON property `refundable` - # @return [Boolean] - attr_accessor :refundable - alias_method :refundable?, :refundable - - # IATA country code representing the point of sale. This determines the " - # equivalent amount paid" currency for the ticket. - # Corresponds to the JSON property `saleCountry` - # @return [String] - attr_accessor :sale_country - - # The slices that make up the itinerary of this trip. A slice represents a - # traveler's intent, the portion of a low-fare search corresponding to a - # traveler's request to get between two points. One-way journeys are generally - # expressed using one slice, round-trips using two. An example of a one slice - # trip with three segments might be BOS-SYD, SYD-LAX, LAX-BOS if the traveler - # only stopped in SYD and LAX just long enough to change planes. - # Corresponds to the JSON property `slice` - # @return [Array] - attr_accessor :slice - - # The number of solutions to return, maximum 500. - # Corresponds to the JSON property `solutions` - # @return [Fixnum] - attr_accessor :solutions - - # IATA country code representing the point of ticketing. - # Corresponds to the JSON property `ticketingCountry` - # @return [String] - attr_accessor :ticketing_country - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @max_price = args[:max_price] if args.key?(:max_price) - @passengers = args[:passengers] if args.key?(:passengers) - @refundable = args[:refundable] if args.key?(:refundable) - @sale_country = args[:sale_country] if args.key?(:sale_country) - @slice = args[:slice] if args.key?(:slice) - @solutions = args[:solutions] if args.key?(:solutions) - @ticketing_country = args[:ticketing_country] if args.key?(:ticketing_country) - end - end - - # A QPX Express search response. - class TripOptionsResponse - include Google::Apis::Core::Hashable - - # Detailed information about components found in the solutions of this response, - # including a trip's airport, city, taxes, airline, and aircraft. - # Corresponds to the JSON property `data` - # @return [Google::Apis::QpxExpressV1::Data] - attr_accessor :data - - # Identifies this as a QPX Express trip response object, which consists of zero - # or more solutions. Value: the fixed string qpxexpress#tripOptions. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # An identifier uniquely identifying this response. - # Corresponds to the JSON property `requestId` - # @return [String] - attr_accessor :request_id - - # A list of priced itinerary solutions to the QPX Express query. - # Corresponds to the JSON property `tripOption` - # @return [Array] - attr_accessor :trip_option - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @data = args[:data] if args.key?(:data) - @kind = args[:kind] if args.key?(:kind) - @request_id = args[:request_id] if args.key?(:request_id) - @trip_option = args[:trip_option] if args.key?(:trip_option) - end - end - - # A QPX Express search request. - class SearchTripsRequest - include Google::Apis::Core::Hashable - - # A QPX Express search request, which will yield one or more solutions. - # Corresponds to the JSON property `request` - # @return [Google::Apis::QpxExpressV1::TripOptionsRequest] - attr_accessor :request - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @request = args[:request] if args.key?(:request) - end - end - - # A QPX Express search response. - class SearchTripsResponse - include Google::Apis::Core::Hashable - - # Identifies this as a QPX Express API search response resource. Value: the - # fixed string qpxExpress#tripsSearch. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # A QPX Express search response. - # Corresponds to the JSON property `trips` - # @return [Google::Apis::QpxExpressV1::TripOptionsResponse] - attr_accessor :trips - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @trips = args[:trips] if args.key?(:trips) - end - end - end - end -end diff --git a/generated/google/apis/qpx_express_v1/representations.rb b/generated/google/apis/qpx_express_v1/representations.rb deleted file mode 100644 index 5f9a3e9da..000000000 --- a/generated/google/apis/qpx_express_v1/representations.rb +++ /dev/null @@ -1,473 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module QpxExpressV1 - - class AircraftData - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AirportData - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BagDescriptor - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CarrierData - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CityData - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Data - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FareInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FlightInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FreeBaggageAllowance - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class LegInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PassengerCounts - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PricingInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SegmentInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SegmentPricing - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SliceInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SliceInput - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TaxData - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TaxInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TimeOfDayRange - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TripOption - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TripOptionsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TripOptionsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SearchTripsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SearchTripsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AircraftData - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :code, as: 'code' - property :kind, as: 'kind' - property :name, as: 'name' - end - end - - class AirportData - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :city, as: 'city' - property :code, as: 'code' - property :kind, as: 'kind' - property :name, as: 'name' - end - end - - class BagDescriptor - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :commercial_name, as: 'commercialName' - property :count, as: 'count' - collection :description, as: 'description' - property :kind, as: 'kind' - property :subcode, as: 'subcode' - end - end - - class CarrierData - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :code, as: 'code' - property :kind, as: 'kind' - property :name, as: 'name' - end - end - - class CityData - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :code, as: 'code' - property :country, as: 'country' - property :kind, as: 'kind' - property :name, as: 'name' - end - end - - class Data - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :aircraft, as: 'aircraft', class: Google::Apis::QpxExpressV1::AircraftData, decorator: Google::Apis::QpxExpressV1::AircraftData::Representation - - collection :airport, as: 'airport', class: Google::Apis::QpxExpressV1::AirportData, decorator: Google::Apis::QpxExpressV1::AirportData::Representation - - collection :carrier, as: 'carrier', class: Google::Apis::QpxExpressV1::CarrierData, decorator: Google::Apis::QpxExpressV1::CarrierData::Representation - - collection :city, as: 'city', class: Google::Apis::QpxExpressV1::CityData, decorator: Google::Apis::QpxExpressV1::CityData::Representation - - property :kind, as: 'kind' - collection :tax, as: 'tax', class: Google::Apis::QpxExpressV1::TaxData, decorator: Google::Apis::QpxExpressV1::TaxData::Representation - - end - end - - class FareInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :basis_code, as: 'basisCode' - property :carrier, as: 'carrier' - property :destination, as: 'destination' - property :id, as: 'id' - property :kind, as: 'kind' - property :origin, as: 'origin' - property :private, as: 'private' - end - end - - class FlightInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :carrier, as: 'carrier' - property :number, as: 'number' - end - end - - class FreeBaggageAllowance - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :bag_descriptor, as: 'bagDescriptor', class: Google::Apis::QpxExpressV1::BagDescriptor, decorator: Google::Apis::QpxExpressV1::BagDescriptor::Representation - - property :kilos, as: 'kilos' - property :kilos_per_piece, as: 'kilosPerPiece' - property :kind, as: 'kind' - property :pieces, as: 'pieces' - property :pounds, as: 'pounds' - end - end - - class LegInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :aircraft, as: 'aircraft' - property :arrival_time, as: 'arrivalTime' - property :change_plane, as: 'changePlane' - property :connection_duration, as: 'connectionDuration' - property :departure_time, as: 'departureTime' - property :destination, as: 'destination' - property :destination_terminal, as: 'destinationTerminal' - property :duration, as: 'duration' - property :id, as: 'id' - property :kind, as: 'kind' - property :meal, as: 'meal' - property :mileage, as: 'mileage' - property :on_time_performance, as: 'onTimePerformance' - property :operating_disclosure, as: 'operatingDisclosure' - property :origin, as: 'origin' - property :origin_terminal, as: 'originTerminal' - property :secure, as: 'secure' - end - end - - class PassengerCounts - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :adult_count, as: 'adultCount' - property :child_count, as: 'childCount' - property :infant_in_lap_count, as: 'infantInLapCount' - property :infant_in_seat_count, as: 'infantInSeatCount' - property :kind, as: 'kind' - property :senior_count, as: 'seniorCount' - end - end - - class PricingInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :base_fare_total, as: 'baseFareTotal' - collection :fare, as: 'fare', class: Google::Apis::QpxExpressV1::FareInfo, decorator: Google::Apis::QpxExpressV1::FareInfo::Representation - - property :fare_calculation, as: 'fareCalculation' - property :kind, as: 'kind' - property :latest_ticketing_time, as: 'latestTicketingTime' - property :passengers, as: 'passengers', class: Google::Apis::QpxExpressV1::PassengerCounts, decorator: Google::Apis::QpxExpressV1::PassengerCounts::Representation - - property :ptc, as: 'ptc' - property :refundable, as: 'refundable' - property :sale_fare_total, as: 'saleFareTotal' - property :sale_tax_total, as: 'saleTaxTotal' - property :sale_total, as: 'saleTotal' - collection :segment_pricing, as: 'segmentPricing', class: Google::Apis::QpxExpressV1::SegmentPricing, decorator: Google::Apis::QpxExpressV1::SegmentPricing::Representation - - collection :tax, as: 'tax', class: Google::Apis::QpxExpressV1::TaxInfo, decorator: Google::Apis::QpxExpressV1::TaxInfo::Representation - - end - end - - class SegmentInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :booking_code, as: 'bookingCode' - property :booking_code_count, as: 'bookingCodeCount' - property :cabin, as: 'cabin' - property :connection_duration, as: 'connectionDuration' - property :duration, as: 'duration' - property :flight, as: 'flight', class: Google::Apis::QpxExpressV1::FlightInfo, decorator: Google::Apis::QpxExpressV1::FlightInfo::Representation - - property :id, as: 'id' - property :kind, as: 'kind' - collection :leg, as: 'leg', class: Google::Apis::QpxExpressV1::LegInfo, decorator: Google::Apis::QpxExpressV1::LegInfo::Representation - - property :married_segment_group, as: 'marriedSegmentGroup' - property :subject_to_government_approval, as: 'subjectToGovernmentApproval' - end - end - - class SegmentPricing - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :fare_id, as: 'fareId' - collection :free_baggage_option, as: 'freeBaggageOption', class: Google::Apis::QpxExpressV1::FreeBaggageAllowance, decorator: Google::Apis::QpxExpressV1::FreeBaggageAllowance::Representation - - property :kind, as: 'kind' - property :segment_id, as: 'segmentId' - end - end - - class SliceInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :duration, as: 'duration' - property :kind, as: 'kind' - collection :segment, as: 'segment', class: Google::Apis::QpxExpressV1::SegmentInfo, decorator: Google::Apis::QpxExpressV1::SegmentInfo::Representation - - end - end - - class SliceInput - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :alliance, as: 'alliance' - property :date, as: 'date' - property :destination, as: 'destination' - property :kind, as: 'kind' - property :max_connection_duration, as: 'maxConnectionDuration' - property :max_stops, as: 'maxStops' - property :origin, as: 'origin' - collection :permitted_carrier, as: 'permittedCarrier' - property :permitted_departure_time, as: 'permittedDepartureTime', class: Google::Apis::QpxExpressV1::TimeOfDayRange, decorator: Google::Apis::QpxExpressV1::TimeOfDayRange::Representation - - property :preferred_cabin, as: 'preferredCabin' - collection :prohibited_carrier, as: 'prohibitedCarrier' - end - end - - class TaxData - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :id, as: 'id' - property :kind, as: 'kind' - property :name, as: 'name' - end - end - - class TaxInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :charge_type, as: 'chargeType' - property :code, as: 'code' - property :country, as: 'country' - property :id, as: 'id' - property :kind, as: 'kind' - property :sale_price, as: 'salePrice' - end - end - - class TimeOfDayRange - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :earliest_time, as: 'earliestTime' - property :kind, as: 'kind' - property :latest_time, as: 'latestTime' - end - end - - class TripOption - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :id, as: 'id' - property :kind, as: 'kind' - collection :pricing, as: 'pricing', class: Google::Apis::QpxExpressV1::PricingInfo, decorator: Google::Apis::QpxExpressV1::PricingInfo::Representation - - property :sale_total, as: 'saleTotal' - collection :slice, as: 'slice', class: Google::Apis::QpxExpressV1::SliceInfo, decorator: Google::Apis::QpxExpressV1::SliceInfo::Representation - - end - end - - class TripOptionsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :max_price, as: 'maxPrice' - property :passengers, as: 'passengers', class: Google::Apis::QpxExpressV1::PassengerCounts, decorator: Google::Apis::QpxExpressV1::PassengerCounts::Representation - - property :refundable, as: 'refundable' - property :sale_country, as: 'saleCountry' - collection :slice, as: 'slice', class: Google::Apis::QpxExpressV1::SliceInput, decorator: Google::Apis::QpxExpressV1::SliceInput::Representation - - property :solutions, as: 'solutions' - property :ticketing_country, as: 'ticketingCountry' - end - end - - class TripOptionsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :data, as: 'data', class: Google::Apis::QpxExpressV1::Data, decorator: Google::Apis::QpxExpressV1::Data::Representation - - property :kind, as: 'kind' - property :request_id, as: 'requestId' - collection :trip_option, as: 'tripOption', class: Google::Apis::QpxExpressV1::TripOption, decorator: Google::Apis::QpxExpressV1::TripOption::Representation - - end - end - - class SearchTripsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :request, as: 'request', class: Google::Apis::QpxExpressV1::TripOptionsRequest, decorator: Google::Apis::QpxExpressV1::TripOptionsRequest::Representation - - end - end - - class SearchTripsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :trips, as: 'trips', class: Google::Apis::QpxExpressV1::TripOptionsResponse, decorator: Google::Apis::QpxExpressV1::TripOptionsResponse::Representation - - end - end - end - end -end diff --git a/generated/google/apis/runtimeconfig_v1beta1.rb b/generated/google/apis/runtimeconfig_v1beta1.rb index 0436b3fe3..1c704fde2 100644 --- a/generated/google/apis/runtimeconfig_v1beta1.rb +++ b/generated/google/apis/runtimeconfig_v1beta1.rb @@ -28,7 +28,7 @@ module Google # @see https://cloud.google.com/deployment-manager/runtime-configurator/ module RuntimeconfigV1beta1 VERSION = 'V1beta1' - REVISION = '20170829' + REVISION = '20171030' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/runtimeconfig_v1beta1/classes.rb b/generated/google/apis/runtimeconfig_v1beta1/classes.rb index 0bb55f119..e4c6e7a6e 100644 --- a/generated/google/apis/runtimeconfig_v1beta1/classes.rb +++ b/generated/google/apis/runtimeconfig_v1beta1/classes.rb @@ -416,8 +416,9 @@ module Google # The resource name of a runtime config. The name must have the format: # projects/[PROJECT_ID]/configs/[CONFIG_NAME] # The `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an - # arbitrary name that matches RFC 1035 segment specification. The length of - # `[CONFIG_NAME]` must be less than 64 bytes. + # arbitrary name that matches + # [0-9A-Za-z](?:[_.A-Za-z0-9-]`0,62`[_.A-Za-z0-9])? regular expression. + # The length of `[CONFIG_NAME]` must be less than 64 characters. # You pick the RuntimeConfig resource name, but the server will validate that # the name adheres to this format. After you create the resource, you cannot # change the resource's name. @@ -611,8 +612,9 @@ module Google # dashes. Slashes are used as path element separators and are not part of the # `[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one # non-slash character. Multiple slashes are coalesced into single slash - # character. Each path segment should follow RFC 1035 segment specification. - # The length of a `[VARIABLE_NAME]` must be less than 256 bytes. + # character. Each path segment should match + # [0-9A-Za-z](?:[_.A-Za-z0-9-]`0,62`[_.A-Za-z0-9])? regular expression. + # The length of a `[VARIABLE_NAME]` must be less than 256 characters. # Once you create a variable, you cannot change the variable name. # Corresponds to the JSON property `name` # @return [String] diff --git a/generated/google/apis/script_v1.rb b/generated/google/apis/script_v1.rb index 52c6261c7..46ebf2a16 100644 --- a/generated/google/apis/script_v1.rb +++ b/generated/google/apis/script_v1.rb @@ -18,14 +18,14 @@ require 'google/apis/script_v1/representations.rb' module Google module Apis - # Google Apps Script Execution API + # Google Apps Script API # # An API for managing and executing Google Apps Script projects. # # @see https://developers.google.com/apps-script/execution/rest/v1/scripts/run module ScriptV1 VERSION = 'V1' - REVISION = '20170927' + REVISION = '20171113' # Read, send, delete, and manage your email AUTH_SCOPE = 'https://mail.google.com/' diff --git a/generated/google/apis/script_v1/classes.rb b/generated/google/apis/script_v1/classes.rb index 37d09c8a5..65f0af6d8 100644 --- a/generated/google/apis/script_v1/classes.rb +++ b/generated/google/apis/script_v1/classes.rb @@ -22,12 +22,13 @@ module Google module Apis module ScriptV1 - # An object that provides information about the nature of an error in the Apps - # Script Execution API. If an - # `run` call succeeds but the - # script function (or Apps Script itself) throws an exception, the response - # body's `error` field contains a - # `Status` object. The `Status` object's `details` field + # An object that provides information about the nature of an error resulting + # from an attempted execution of a script function using the Apps Script API. + # If a run call + # succeeds but the script function (or Apps Script itself) throws an exception, + # the response body's error field + # contains a + # Status object. The `Status` object's `details` field # contains an array with a single one of these `ExecutionError` objects. class ExecutionError include Google::Apis::Core::Hashable @@ -70,7 +71,7 @@ module Google # If `true` and the user is an owner of the script, the script runs at the # most recently saved version rather than the version deployed for use with - # the Execution API. Optional; default is `false`. + # the Apps Script API. Optional; default is `false`. # Corresponds to the JSON property `devMode` # @return [Boolean] attr_accessor :dev_mode @@ -93,12 +94,13 @@ module Google # For Android add-ons only. An ID that represents the user's current session # in the Android app for Google Docs or Sheets, included as extra data in the - # [`Intent`](https://developer.android.com/guide/components/intents-filters.html) + # [Intent](https://developer.android.com/guide/components/intents-filters.html) # that launches the add-on. When an Android add-on is run with a session # state, it gains the privileges of a - # [bound](https://developers.google.com/apps-script/guides/bound) script — - # that is, it can access information like the user's current cursor position - # (in Docs) or selected cell (in Sheets). To retrieve the state, call + # [bound](https://developers.google.com/apps-script/guides/bound) + # script—that is, it can access information like the user's current + # cursor position (in Docs) or selected cell (in Sheets). To retrieve the + # state, call # `Intent.getStringExtra("com.google.android.apps.docs.addons.SessionState")`. # Optional. # Corresponds to the JSON property `sessionState` @@ -118,17 +120,15 @@ module Google end end - # An object that provides the return value of a function executed through the - # Apps Script Execution API. If a - # `run` call succeeds and the - # script function returns successfully, the response body's - # `response` field contains this + # An object that provides the return value of a function executed using the + # Apps Script API. If the script function returns successfully, the response + # body's response field contains this # `ExecutionResponse` object. class ExecutionResponse include Google::Apis::Core::Hashable # The return value of the script function. The type matches the object type - # returned in Apps Script. Functions called through the Execution API cannot + # returned in Apps Script. Functions called using the Apps Script API cannot # return Apps Script-specific objects (such as a `Document` or a `Calendar`); # they can only return primitive types such as a `string`, `number`, `array`, # `object`, or `boolean`. @@ -146,47 +146,50 @@ module Google end end - # The response will not arrive until the function finishes executing. The - # maximum runtime is listed in the guide to [limitations in Apps Script](https:// - # developers.google.com/apps-script/guides/services/quotas#current_limitations). - #

If the script function returns successfully, the `response` field will - # contain an `ExecutionResponse` object with the function's return value in the - # object's `result` field.

- #

If the script function (or Apps Script itself) throws an exception, the ` - # error` field will contain a `Status` object. The `Status` object's `details` - # field will contain an array with a single `ExecutionError` object that - # provides information about the nature of the error.

- #

If the `run` call itself fails (for example, because of a malformed request - # or an authorization error), the method will return an HTTP response code in - # the 4XX range with a different format for the response body. Client libraries - # will automatically convert a 4XX response into an exception class.

+ # A representation of a execution of an Apps Script function that is started + # using run. The execution response does not arrive until the function finishes + # executing. The maximum execution runtime is listed in the [Apps Script quotas + # guide](/apps-script/guides/services/quotas#current_limitations).

After the + # execution is started, it can have one of four outcomes:

  • If the + # script function returns successfully, the + # response field contains an + # ExecutionResponse object + # with the function's return value in the object's `result` field.
    • + #
  • If the script function (or Apps Script itself) throws an exception, the + # error field contains a + # Status object. The `Status` object's `details` + # field contains an array with a single + # ExecutionError object that + # provides information about the nature of the error.
    • + #
  • If the execution has not yet completed, + # the done field is `false` and + # the neither the `response` nor `error` fields are present.
    • + #
  • If the `run` call itself fails (for example, because of a + # malformed request or an authorization error), the method returns an HTTP + # response code in the 4XX range with a different format for the response + # body. Client libraries automatically convert a 4XX response into an + # exception class.
    • + #
class Operation include Google::Apis::Core::Hashable - # This field is only used with asynchronous executions and indicates whether or - # not the script execution has completed. A completed execution has a populated - # response field containing the `ExecutionResponse` from function that was - # executed. + # This field indicates whether the script execution has completed. A completed + # execution has a populated `response` field containing the ExecutionResponse + # from function that was executed. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done # If a `run` call succeeds but the script function (or Apps Script itself) - # throws an exception, the response body's `error` field will contain this ` - # Status` object. + # throws an exception, the response body's error field contains this `Status` + # object. # Corresponds to the JSON property `error` # @return [Google::Apis::ScriptV1::Status] attr_accessor :error - # This field is not used. - # Corresponds to the JSON property `metadata` - # @return [Hash] - attr_accessor :metadata - - # If the script function returns successfully, this field will contain an ` - # ExecutionResponse` object with the function's return value as the object's ` - # result` field. + # If the script function returns successfully, this field contains an + # ExecutionResponse object with the function's return value. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response @@ -199,7 +202,6 @@ module Google def update!(**args) @done = args[:done] if args.key?(:done) @error = args[:error] if args.key?(:error) - @metadata = args[:metadata] if args.key?(:metadata) @response = args[:response] if args.key?(:response) end end @@ -230,25 +232,26 @@ module Google end # If a `run` call succeeds but the script function (or Apps Script itself) - # throws an exception, the response body's `error` field will contain this ` - # Status` object. + # throws an exception, the response body's error field contains this `Status` + # object. class Status include Google::Apis::Core::Hashable - # The status code. For this API, this value will always be 3, corresponding to - # an INVALID_ARGUMENT error. + # The status code. For this API, this value either:
  • 3, indicating an ` + # INVALID_ARGUMENT` error, or
  • 1, indicating a `CANCELLED` execution.
# Corresponds to the JSON property `code` # @return [Fixnum] attr_accessor :code - # An array that contains a single `ExecutionError` object that provides + # An array that contains a single ExecutionError object that provides # information about the nature of the error. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details # A developer-facing error message, which is in English. Any user-facing error - # message is localized and sent in the [`google.rpc.Status.details`](google.rpc. + # message is localized and sent in the [google.rpc.Status.details](google.rpc. # Status.details) field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] diff --git a/generated/google/apis/script_v1/representations.rb b/generated/google/apis/script_v1/representations.rb index 80fbe8b62..0d9eb8036 100644 --- a/generated/google/apis/script_v1/representations.rb +++ b/generated/google/apis/script_v1/representations.rb @@ -91,7 +91,6 @@ module Google property :done, as: 'done' property :error, as: 'error', class: Google::Apis::ScriptV1::Status, decorator: Google::Apis::ScriptV1::Status::Representation - hash :metadata, as: 'metadata' hash :response, as: 'response' end end diff --git a/generated/google/apis/script_v1/service.rb b/generated/google/apis/script_v1/service.rb index fb836e46a..8822fbf63 100644 --- a/generated/google/apis/script_v1/service.rb +++ b/generated/google/apis/script_v1/service.rb @@ -20,7 +20,7 @@ require 'google/apis/errors' module Google module Apis module ScriptV1 - # Google Apps Script Execution API + # Google Apps Script API # # An API for managing and executing Google Apps Script projects. # @@ -48,7 +48,7 @@ module Google end # Runs a function in an Apps Script project. The project must be deployed - # for use with the Apps Script Execution API. + # for use with the Apps Script API. # This method requires authorization with an OAuth 2.0 token that includes at # least one of the scopes listed in the [Authorization](#authorization) # section; script projects that do not require authorization cannot be diff --git a/generated/google/apis/serviceconsumermanagement_v1.rb b/generated/google/apis/serviceconsumermanagement_v1.rb new file mode 100644 index 000000000..57af5e8b9 --- /dev/null +++ b/generated/google/apis/serviceconsumermanagement_v1.rb @@ -0,0 +1,38 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/serviceconsumermanagement_v1/service.rb' +require 'google/apis/serviceconsumermanagement_v1/classes.rb' +require 'google/apis/serviceconsumermanagement_v1/representations.rb' + +module Google + module Apis + # Service Consumer Management API + # + # Provides management methods for configuring service producer resources on + # Google Cloud. + # + # @see https://cloud.google.com/service-consumer-management/docs/overview + module ServiceconsumermanagementV1 + VERSION = 'V1' + REVISION = '20171113' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + + # Manage your Google API service configuration + AUTH_SERVICE_MANAGEMENT = 'https://www.googleapis.com/auth/service.management' + end + end +end diff --git a/generated/google/apis/serviceconsumermanagement_v1/classes.rb b/generated/google/apis/serviceconsumermanagement_v1/classes.rb new file mode 100644 index 000000000..a73b1493b --- /dev/null +++ b/generated/google/apis/serviceconsumermanagement_v1/classes.rb @@ -0,0 +1,3945 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module ServiceconsumermanagementV1 + + # Request to add a newly created and configured tenant project to tenancy + # unit. + class AddTenantProjectRequest + include Google::Apis::Core::Hashable + + # This structure defines a tenant project to be added to the specified tenancy + # unit and its initial configuration and properties. A project lien will be + # created for the tenant project to prevent the tenant project from being + # deleted accidentally. The lien will be deleted as part of tenant project + # removal. + # Corresponds to the JSON property `projectConfig` + # @return [Google::Apis::ServiceconsumermanagementV1::TenantProjectConfig] + attr_accessor :project_config + + # Tag of the added project. Must be less than 128 characters. Required. + # Corresponds to the JSON property `tag` + # @return [String] + attr_accessor :tag + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @project_config = args[:project_config] if args.key?(:project_config) + @tag = args[:tag] if args.key?(:tag) + end + end + + # Api is a light-weight descriptor for an API Interface. + # Interfaces are also described as "protocol buffer services" in some contexts, + # such as by the "service" keyword in a .proto file, but they are different + # from API Services, which represent a concrete implementation of an interface + # as opposed to simply a description of methods and bindings. They are also + # sometimes simply referred to as "APIs" in other contexts, such as the name of + # this message itself. See https://cloud.google.com/apis/design/glossary for + # detailed terminology. + class Api + include Google::Apis::Core::Hashable + + # The methods of this interface, in unspecified order. + # Corresponds to the JSON property `methods` + # @return [Array] + attr_accessor :methods_prop + + # Included interfaces. See Mixin. + # Corresponds to the JSON property `mixins` + # @return [Array] + attr_accessor :mixins + + # The fully qualified name of this interface, including package name + # followed by the interface's simple name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Any metadata attached to the interface. + # Corresponds to the JSON property `options` + # @return [Array] + attr_accessor :options + + # `SourceContext` represents information about the source of a + # protobuf element, like the file in which it is defined. + # Corresponds to the JSON property `sourceContext` + # @return [Google::Apis::ServiceconsumermanagementV1::SourceContext] + attr_accessor :source_context + + # The source syntax of the service. + # Corresponds to the JSON property `syntax` + # @return [String] + attr_accessor :syntax + + # A version string for this interface. If specified, must have the form + # `major-version.minor-version`, as in `1.10`. If the minor version is + # omitted, it defaults to zero. If the entire version field is empty, the + # major version is derived from the package name, as outlined below. If the + # field is not empty, the version in the package name will be verified to be + # consistent with what is provided here. + # The versioning schema uses [semantic + # versioning](http://semver.org) where the major version number + # indicates a breaking change and the minor version an additive, + # non-breaking change. Both version numbers are signals to users + # what to expect from different versions, and should be carefully + # chosen based on the product plan. + # The major version is also reflected in the package name of the + # interface, which must end in `v`, as in + # `google.feature.v1`. For major versions 0 and 1, the suffix can + # be omitted. Zero major versions must only be used for + # experimental, non-GA interfaces. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @methods_prop = args[:methods_prop] if args.key?(:methods_prop) + @mixins = args[:mixins] if args.key?(:mixins) + @name = args[:name] if args.key?(:name) + @options = args[:options] if args.key?(:options) + @source_context = args[:source_context] if args.key?(:source_context) + @syntax = args[:syntax] if args.key?(:syntax) + @version = args[:version] if args.key?(:version) + end + end + + # Configuration for an anthentication provider, including support for + # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web- + # token-32). + class AuthProvider + include Google::Apis::Core::Hashable + + # The list of JWT + # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# + # section-4.1.3). + # that are allowed to access. A JWT containing any of these audiences will + # be accepted. When this setting is absent, only JWTs with audience + # "https://Service_name/API_name" + # will be accepted. For example, if no audiences are in the setting, + # LibraryService API will only accept JWTs with the following audience + # "https://library-example.googleapis.com/google.example.library.v1. + # LibraryService". + # Example: + # audiences: bookstore_android.apps.googleusercontent.com, + # bookstore_web.apps.googleusercontent.com + # Corresponds to the JSON property `audiences` + # @return [String] + attr_accessor :audiences + + # Redirect URL if JWT token is required but no present or is expired. + # Implement authorizationUrl of securityDefinitions in OpenAPI spec. + # Corresponds to the JSON property `authorizationUrl` + # @return [String] + attr_accessor :authorization_url + + # The unique identifier of the auth provider. It will be referred to by + # `AuthRequirement.provider_id`. + # Example: "bookstore_auth". + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies the principal that issued the JWT. See + # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 + # Usually a URL or an email address. + # Example: https://securetoken.google.com + # Example: 1234567-compute@developer.gserviceaccount.com + # Corresponds to the JSON property `issuer` + # @return [String] + attr_accessor :issuer + + # URL of the provider's public key set to validate signature of the JWT. See + # [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# + # ProviderMetadata). + # Optional if the key set document: + # - can be retrieved from + # [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0. + # html + # of the issuer. + # - can be inferred from the email domain of the issuer (e.g. a Google service + # account). + # Example: https://www.googleapis.com/oauth2/v1/certs + # Corresponds to the JSON property `jwksUri` + # @return [String] + attr_accessor :jwks_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audiences = args[:audiences] if args.key?(:audiences) + @authorization_url = args[:authorization_url] if args.key?(:authorization_url) + @id = args[:id] if args.key?(:id) + @issuer = args[:issuer] if args.key?(:issuer) + @jwks_uri = args[:jwks_uri] if args.key?(:jwks_uri) + end + end + + # User-defined authentication requirements, including support for + # [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web- + # token-32). + class AuthRequirement + include Google::Apis::Core::Hashable + + # NOTE: This will be deprecated soon, once AuthProvider.audiences is + # implemented and accepted in all the runtime components. + # The list of JWT + # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32# + # section-4.1.3). + # that are allowed to access. A JWT containing any of these audiences will + # be accepted. When this setting is absent, only JWTs with audience + # "https://Service_name/API_name" + # will be accepted. For example, if no audiences are in the setting, + # LibraryService API will only accept JWTs with the following audience + # "https://library-example.googleapis.com/google.example.library.v1. + # LibraryService". + # Example: + # audiences: bookstore_android.apps.googleusercontent.com, + # bookstore_web.apps.googleusercontent.com + # Corresponds to the JSON property `audiences` + # @return [String] + attr_accessor :audiences + + # id from authentication provider. + # Example: + # provider_id: bookstore_auth + # Corresponds to the JSON property `providerId` + # @return [String] + attr_accessor :provider_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audiences = args[:audiences] if args.key?(:audiences) + @provider_id = args[:provider_id] if args.key?(:provider_id) + end + end + + # `Authentication` defines the authentication configuration for an API. + # Example for an API targeted for external use: + # name: calendar.googleapis.com + # authentication: + # providers: + # - id: google_calendar_auth + # jwks_uri: https://www.googleapis.com/oauth2/v1/certs + # issuer: https://securetoken.google.com + # rules: + # - selector: "*" + # requirements: + # provider_id: google_calendar_auth + class Authentication + include Google::Apis::Core::Hashable + + # Defines a set of authentication providers that a service supports. + # Corresponds to the JSON property `providers` + # @return [Array] + attr_accessor :providers + + # A list of authentication rules that apply to individual API methods. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @providers = args[:providers] if args.key?(:providers) + @rules = args[:rules] if args.key?(:rules) + end + end + + # Authentication rules for the service. + # By default, if a method has any authentication requirements, every request + # must include a valid credential matching one of the requirements. + # It's an error to include more than one kind of credential in a single + # request. + # If a method doesn't have any auth requirements, request credentials will be + # ignored. + class AuthenticationRule + include Google::Apis::Core::Hashable + + # Whether to allow requests without a credential. The credential can be + # an OAuth token, Google cookies (first-party auth) or EndUserCreds. + # For requests without credentials, if the service control environment is + # specified, each incoming request **must** be associated with a service + # consumer. This can be done by passing an API key that belongs to a consumer + # project. + # Corresponds to the JSON property `allowWithoutCredential` + # @return [Boolean] + attr_accessor :allow_without_credential + alias_method :allow_without_credential?, :allow_without_credential + + # Configuration for a custom authentication provider. + # Corresponds to the JSON property `customAuth` + # @return [Google::Apis::ServiceconsumermanagementV1::CustomAuthRequirements] + attr_accessor :custom_auth + + # OAuth scopes are a way to define data and permissions on data. For example, + # there are scopes defined for "Read-only access to Google Calendar" and + # "Access to Cloud Platform". Users can consent to a scope for an application, + # giving it permission to access that data on their behalf. + # OAuth scope specifications should be fairly coarse grained; a user will need + # to see and understand the text description of what your scope means. + # In most cases: use one or at most two OAuth scopes for an entire family of + # products. If your product has multiple APIs, you should probably be sharing + # the OAuth scope across all of those APIs. + # When you need finer grained OAuth consent screens: talk with your product + # management about how developers will use them in practice. + # Please note that even though each of the canonical scopes is enough for a + # request to be accepted and passed to the backend, a request can still fail + # due to the backend requiring additional scopes or permissions. + # Corresponds to the JSON property `oauth` + # @return [Google::Apis::ServiceconsumermanagementV1::OAuthRequirements] + attr_accessor :oauth + + # Requirements for additional authentication providers. + # Corresponds to the JSON property `requirements` + # @return [Array] + attr_accessor :requirements + + # Selects the methods to which this rule applies. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allow_without_credential = args[:allow_without_credential] if args.key?(:allow_without_credential) + @custom_auth = args[:custom_auth] if args.key?(:custom_auth) + @oauth = args[:oauth] if args.key?(:oauth) + @requirements = args[:requirements] if args.key?(:requirements) + @selector = args[:selector] if args.key?(:selector) + end + end + + # Configuration of authorization. + # This section determines the authorization provider, if unspecified, then no + # authorization check will be done. + # Example: + # experimental: + # authorization: + # provider: firebaserules.googleapis.com + class AuthorizationConfig + include Google::Apis::Core::Hashable + + # The name of the authorization provider, such as + # firebaserules.googleapis.com. + # Corresponds to the JSON property `provider` + # @return [String] + attr_accessor :provider + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @provider = args[:provider] if args.key?(:provider) + end + end + + # Authorization rule for API services. + # It specifies the permission(s) required for an API element for the overall + # API request to succeed. It is typically used to mark request message fields + # that contain the name of the resource and indicates the permissions that + # will be checked on that resource. + # For example: + # package google.storage.v1; + # message CopyObjectRequest ` + # string source = 1 [ + # (google.api.authz).permissions = "storage.objects.get"]; + # string destination = 2 [ + # (google.api.authz).permissions = + # "storage.objects.create,storage.objects.update"]; + # ` + class AuthorizationRule + include Google::Apis::Core::Hashable + + # The required permissions. The acceptable values vary depend on the + # authorization system used. For Google APIs, it should be a comma-separated + # Google IAM permission values. When multiple permissions are listed, the + # semantics is not defined by the system. Additional documentation must + # be provided manually. + # Corresponds to the JSON property `permissions` + # @return [String] + attr_accessor :permissions + + # Selects the API elements to which this rule applies. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @permissions = args[:permissions] if args.key?(:permissions) + @selector = args[:selector] if args.key?(:selector) + end + end + + # `Backend` defines the backend configuration for a service. + class Backend + include Google::Apis::Core::Hashable + + # A list of API backend rules that apply to individual API methods. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @rules = args[:rules] if args.key?(:rules) + end + end + + # A backend rule provides configuration for an individual API element. + class BackendRule + include Google::Apis::Core::Hashable + + # The address of the API backend. + # Corresponds to the JSON property `address` + # @return [String] + attr_accessor :address + + # The number of seconds to wait for a response from a request. The default + # deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. + # Corresponds to the JSON property `deadline` + # @return [Float] + attr_accessor :deadline + + # Minimum deadline in seconds needed for this method. Calls having deadline + # value lower than this will be rejected. + # Corresponds to the JSON property `minDeadline` + # @return [Float] + attr_accessor :min_deadline + + # Selects the methods to which this rule applies. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @address = args[:address] if args.key?(:address) + @deadline = args[:deadline] if args.key?(:deadline) + @min_deadline = args[:min_deadline] if args.key?(:min_deadline) + @selector = args[:selector] if args.key?(:selector) + end + end + + # Billing related configuration of the service. + # The following example shows how to configure monitored resources and metrics + # for billing: + # monitored_resources: + # - type: library.googleapis.com/branch + # labels: + # - key: /city + # description: The city where the library branch is located in. + # - key: /name + # description: The name of the branch. + # metrics: + # - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA + # value_type: INT64 + # billing: + # consumer_destinations: + # - monitored_resource: library.googleapis.com/branch + # metrics: + # - library.googleapis.com/book/borrowed_count + class Billing + include Google::Apis::Core::Hashable + + # Billing configurations for sending metrics to the consumer project. + # There can be multiple consumer destinations per service, each one must have + # a different monitored resource type. A metric can be used in at most + # one consumer destination. + # Corresponds to the JSON property `consumerDestinations` + # @return [Array] + attr_accessor :consumer_destinations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @consumer_destinations = args[:consumer_destinations] if args.key?(:consumer_destinations) + end + end + + # Describes billing configuration for new a Tenant Project + class BillingConfig + include Google::Apis::Core::Hashable + + # Name of the billing account. + # For example `billingAccounts/012345-567890-ABCDEF`. + # Corresponds to the JSON property `billingAccount` + # @return [String] + attr_accessor :billing_account + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @billing_account = args[:billing_account] if args.key?(:billing_account) + end + end + + # Configuration of a specific billing destination (Currently only support + # bill against consumer project). + class BillingDestination + include Google::Apis::Core::Hashable + + # Names of the metrics to report to this billing destination. + # Each name must be defined in Service.metrics section. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # The monitored resource type. The type must be defined in + # Service.monitored_resources section. + # Corresponds to the JSON property `monitoredResource` + # @return [String] + attr_accessor :monitored_resource + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metrics = args[:metrics] if args.key?(:metrics) + @monitored_resource = args[:monitored_resource] if args.key?(:monitored_resource) + end + end + + # The request message for Operations.CancelOperation. + class CancelOperationRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # `Context` defines which contexts an API requests. + # Example: + # context: + # rules: + # - selector: "*" + # requested: + # - google.rpc.context.ProjectContext + # - google.rpc.context.OriginContext + # The above specifies that all methods in the API request + # `google.rpc.context.ProjectContext` and + # `google.rpc.context.OriginContext`. + # Available context types are defined in package + # `google.rpc.context`. + class Context + include Google::Apis::Core::Hashable + + # A list of RPC context rules that apply to individual API methods. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @rules = args[:rules] if args.key?(:rules) + end + end + + # A context rule provides information about the context for an individual API + # element. + class ContextRule + include Google::Apis::Core::Hashable + + # A list of full type names of provided contexts. + # Corresponds to the JSON property `provided` + # @return [Array] + attr_accessor :provided + + # A list of full type names of requested contexts. + # Corresponds to the JSON property `requested` + # @return [Array] + attr_accessor :requested + + # Selects the methods to which this rule applies. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @provided = args[:provided] if args.key?(:provided) + @requested = args[:requested] if args.key?(:requested) + @selector = args[:selector] if args.key?(:selector) + end + end + + # Selects and configures the service controller used by the service. The + # service controller handles features like abuse, quota, billing, logging, + # monitoring, etc. + class Control + include Google::Apis::Core::Hashable + + # The service control environment to use. If empty, no control plane + # feature (like quota and billing) will be enabled. + # Corresponds to the JSON property `environment` + # @return [String] + attr_accessor :environment + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @environment = args[:environment] if args.key?(:environment) + end + end + + # Request to create a tenancy unit for a consumer of a service. + class CreateTenancyUnitRequest + include Google::Apis::Core::Hashable + + # Optional producer provided identifier of the tenancy unit + # Must be no longer than 40 characters and preferably URI friendly + # If it is not provided, UID for the tenancy unit will be auto generated + # It must be unique across a service. + # If the tenancy unit already exists for the service and consumer pair, + # CreateTenancyUnit will return existing tenancy unit if provided identifier + # is identical or empty, otherwise the call will fail. + # Corresponds to the JSON property `tenancyUnitId` + # @return [String] + attr_accessor :tenancy_unit_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @tenancy_unit_id = args[:tenancy_unit_id] if args.key?(:tenancy_unit_id) + end + end + + # Configuration for a custom authentication provider. + class CustomAuthRequirements + include Google::Apis::Core::Hashable + + # A configuration string containing connection information for the + # authentication provider, typically formatted as a SmartService string + # (go/smartservice). + # Corresponds to the JSON property `provider` + # @return [String] + attr_accessor :provider + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @provider = args[:provider] if args.key?(:provider) + end + end + + # Customize service error responses. For example, list any service + # specific protobuf types that can appear in error detail lists of + # error responses. + # Example: + # custom_error: + # types: + # - google.foo.v1.CustomError + # - google.foo.v1.AnotherError + class CustomError + include Google::Apis::Core::Hashable + + # The list of custom error rules that apply to individual API messages. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. + # Corresponds to the JSON property `types` + # @return [Array] + attr_accessor :types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @rules = args[:rules] if args.key?(:rules) + @types = args[:types] if args.key?(:types) + end + end + + # A custom error rule. + class CustomErrorRule + include Google::Apis::Core::Hashable + + # Mark this message as possible payload in error response. Otherwise, + # objects of this type will be filtered when they appear in error payload. + # Corresponds to the JSON property `isErrorType` + # @return [Boolean] + attr_accessor :is_error_type + alias_method :is_error_type?, :is_error_type + + # Selects messages to which this rule applies. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @is_error_type = args[:is_error_type] if args.key?(:is_error_type) + @selector = args[:selector] if args.key?(:selector) + end + end + + # A custom pattern is used for defining custom HTTP verb. + class CustomHttpPattern + include Google::Apis::Core::Hashable + + # The name of this custom HTTP verb. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The path matched by this custom verb. + # Corresponds to the JSON property `path` + # @return [String] + attr_accessor :path + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @path = args[:path] if args.key?(:path) + end + end + + # `Documentation` provides the information for describing a service. + # Example: + # 
documentation:
+      # summary: >
+      # The Google Calendar API gives access
+      # to most calendar features.
+      # pages:
+      # - name: Overview
+      # content: (== include google/foo/overview.md ==)
+      # - name: Tutorial
+      # content: (== include google/foo/tutorial.md ==)
+      # subpages;
+      # - name: Java
+      # content: (== include google/foo/tutorial_java.md ==)
+      # rules:
+      # - selector: google.calendar.Calendar.Get
+      # description: >
+      # ...
+      # - selector: google.calendar.Calendar.Put
+      # description: >
+      # ...
+      #
+ # Documentation is provided in markdown syntax. In addition to + # standard markdown features, definition lists, tables and fenced + # code blocks are supported. Section headers can be provided and are + # interpreted relative to the section nesting of the context where + # a documentation fragment is embedded. + # Documentation from the IDL is merged with documentation defined + # via the config at normalization time, where documentation provided + # by config rules overrides IDL provided. + # A number of constructs specific to the API platform are supported + # in documentation text. + # In order to reference a proto element, the following + # notation can be used: + # 
[fully.qualified.proto.name][]
+ # To override the display text used for the link, this can be used: + # 
[display text][fully.qualified.proto.name]
+ # Text can be excluded from doc using the following notation: + # 
(-- internal comment --)
+ # Comments can be made conditional using a visibility label. The below + # text will be only rendered if the `BETA` label is available: + # 
(--BETA: comment for BETA users --)
+ # A few directives are available in documentation. Note that + # directives must appear on a single line to be properly + # identified. The `include` directive includes a markdown file from + # an external source: + # 
(== include path/to/file ==)
+ # The `resource_for` directive marks a message to be the resource of + # a collection in REST view. If it is not specified, tools attempt + # to infer the resource from the operations in a collection: + # 
(== resource_for v1.shelves.books ==)
+ # The directive `suppress_warning` does not directly affect documentation + # and is documented together with service config validation. + class Documentation + include Google::Apis::Core::Hashable + + # The URL to the root of documentation. + # Corresponds to the JSON property `documentationRootUrl` + # @return [String] + attr_accessor :documentation_root_url + + # Declares a single overview page. For example: + # 
documentation:
+        # summary: ...
+        # overview: (== include overview.md ==)
+        #
+ # This is a shortcut for the following declaration (using pages style): + # 
documentation:
+        # summary: ...
+        # pages:
+        # - name: Overview
+        # content: (== include overview.md ==)
+        #
+ # Note: you cannot specify both `overview` field and `pages` field. + # Corresponds to the JSON property `overview` + # @return [String] + attr_accessor :overview + + # The top level pages for the documentation set. + # Corresponds to the JSON property `pages` + # @return [Array] + attr_accessor :pages + + # A list of documentation rules that apply to individual API elements. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + # A short summary of what the service does. Can only be provided by + # plain text. + # Corresponds to the JSON property `summary` + # @return [String] + attr_accessor :summary + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @documentation_root_url = args[:documentation_root_url] if args.key?(:documentation_root_url) + @overview = args[:overview] if args.key?(:overview) + @pages = args[:pages] if args.key?(:pages) + @rules = args[:rules] if args.key?(:rules) + @summary = args[:summary] if args.key?(:summary) + end + end + + # A documentation rule provides information about individual API elements. + class DocumentationRule + include Google::Apis::Core::Hashable + + # Deprecation description of the selected element(s). It can be provided if an + # element is marked as `deprecated`. + # Corresponds to the JSON property `deprecationDescription` + # @return [String] + attr_accessor :deprecation_description + + # Description of the selected API(s). + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The selector is a comma-separated list of patterns. Each pattern is a + # qualified name of the element which may end in "*", indicating a wildcard. + # Wildcards are only allowed at the end and for a whole component of the + # qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To + # specify a default for all applicable elements, the whole pattern "*" + # is used. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @deprecation_description = args[:deprecation_description] if args.key?(:deprecation_description) + @description = args[:description] if args.key?(:description) + @selector = args[:selector] if args.key?(:selector) + end + end + + # 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); + # ` + # The JSON representation for `Empty` is empty JSON object ````. + class Empty + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # `Endpoint` describes a network endpoint that serves a set of APIs. + # A service may expose any number of endpoints, and all endpoints share the + # same service configuration, such as quota configuration and monitoring + # configuration. + # Example service configuration: + # name: library-example.googleapis.com + # endpoints: + # # Below entry makes 'google.example.library.v1.Library' + # # API be served from endpoint address library-example.googleapis.com. + # # It also allows HTTP OPTIONS calls to be passed to the backend, for + # # it to decide whether the subsequent cross-origin request is + # # allowed to proceed. + # - name: library-example.googleapis.com + # allow_cors: true + class Endpoint + include Google::Apis::Core::Hashable + + # DEPRECATED: This field is no longer supported. Instead of using aliases, + # please specify multiple google.api.Endpoint for each of the intended + # aliases. + # Additional names that this endpoint will be hosted on. + # Corresponds to the JSON property `aliases` + # @return [Array] + attr_accessor :aliases + + # Allowing + # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka + # cross-domain traffic, would allow the backends served from this endpoint to + # receive and respond to HTTP OPTIONS requests. The response will be used by + # the browser to determine whether the subsequent cross-origin request is + # allowed to proceed. + # Corresponds to the JSON property `allowCors` + # @return [Boolean] + attr_accessor :allow_cors + alias_method :allow_cors?, :allow_cors + + # The list of features enabled on this endpoint. + # Corresponds to the JSON property `features` + # @return [Array] + attr_accessor :features + + # The canonical name of this endpoint. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The specification of an Internet routable address of API frontend that will + # handle requests to this [API Endpoint](https://cloud.google.com/apis/design/ + # glossary). + # It should be either a valid IPv4 address or a fully-qualified domain name. + # For example, "8.8.8.8" or "myservice.appspot.com". + # Corresponds to the JSON property `target` + # @return [String] + attr_accessor :target + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @aliases = args[:aliases] if args.key?(:aliases) + @allow_cors = args[:allow_cors] if args.key?(:allow_cors) + @features = args[:features] if args.key?(:features) + @name = args[:name] if args.key?(:name) + @target = args[:target] if args.key?(:target) + end + end + + # Enum type definition. + class Enum + include Google::Apis::Core::Hashable + + # Enum value definitions. + # Corresponds to the JSON property `enumvalue` + # @return [Array] + attr_accessor :enumvalue + + # Enum type name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Protocol buffer options. + # Corresponds to the JSON property `options` + # @return [Array] + attr_accessor :options + + # `SourceContext` represents information about the source of a + # protobuf element, like the file in which it is defined. + # Corresponds to the JSON property `sourceContext` + # @return [Google::Apis::ServiceconsumermanagementV1::SourceContext] + attr_accessor :source_context + + # The source syntax. + # Corresponds to the JSON property `syntax` + # @return [String] + attr_accessor :syntax + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enumvalue = args[:enumvalue] if args.key?(:enumvalue) + @name = args[:name] if args.key?(:name) + @options = args[:options] if args.key?(:options) + @source_context = args[:source_context] if args.key?(:source_context) + @syntax = args[:syntax] if args.key?(:syntax) + end + end + + # Enum value definition. + class EnumValue + include Google::Apis::Core::Hashable + + # Enum value name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Enum value number. + # Corresponds to the JSON property `number` + # @return [Fixnum] + attr_accessor :number + + # Protocol buffer options. + # Corresponds to the JSON property `options` + # @return [Array] + attr_accessor :options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @number = args[:number] if args.key?(:number) + @options = args[:options] if args.key?(:options) + end + end + + # Experimental service configuration. These configuration options can + # only be used by whitelisted users. + class Experimental + include Google::Apis::Core::Hashable + + # Configuration of authorization. + # This section determines the authorization provider, if unspecified, then no + # authorization check will be done. + # Example: + # experimental: + # authorization: + # provider: firebaserules.googleapis.com + # Corresponds to the JSON property `authorization` + # @return [Google::Apis::ServiceconsumermanagementV1::AuthorizationConfig] + attr_accessor :authorization + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @authorization = args[:authorization] if args.key?(:authorization) + end + end + + # A single field of a message type. + class Field + include Google::Apis::Core::Hashable + + # The field cardinality. + # Corresponds to the JSON property `cardinality` + # @return [String] + attr_accessor :cardinality + + # The string value of the default value of this field. Proto2 syntax only. + # Corresponds to the JSON property `defaultValue` + # @return [String] + attr_accessor :default_value + + # The field JSON name. + # Corresponds to the JSON property `jsonName` + # @return [String] + attr_accessor :json_name + + # The field type. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The field name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The field number. + # Corresponds to the JSON property `number` + # @return [Fixnum] + attr_accessor :number + + # The index of the field type in `Type.oneofs`, for message or enumeration + # types. The first type has index 1; zero means the type is not in the list. + # Corresponds to the JSON property `oneofIndex` + # @return [Fixnum] + attr_accessor :oneof_index + + # The protocol buffer options. + # Corresponds to the JSON property `options` + # @return [Array] + attr_accessor :options + + # Whether to use alternative packed wire representation. + # Corresponds to the JSON property `packed` + # @return [Boolean] + attr_accessor :packed + alias_method :packed?, :packed + + # The field type URL, without the scheme, for message or enumeration + # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. + # Corresponds to the JSON property `typeUrl` + # @return [String] + attr_accessor :type_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cardinality = args[:cardinality] if args.key?(:cardinality) + @default_value = args[:default_value] if args.key?(:default_value) + @json_name = args[:json_name] if args.key?(:json_name) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + @number = args[:number] if args.key?(:number) + @oneof_index = args[:oneof_index] if args.key?(:oneof_index) + @options = args[:options] if args.key?(:options) + @packed = args[:packed] if args.key?(:packed) + @type_url = args[:type_url] if args.key?(:type_url) + end + end + + # Defines the HTTP configuration for an API service. It contains a list of + # HttpRule, each specifying the mapping of an RPC method + # to one or more HTTP REST API methods. + class Http + include Google::Apis::Core::Hashable + + # When set to true, URL path parmeters will be fully URI-decoded except in + # cases of single segment matches in reserved expansion, where "%2F" will be + # left encoded. + # The default behavior is to not decode RFC 6570 reserved characters in multi + # segment matches. + # Corresponds to the JSON property `fullyDecodeReservedExpansion` + # @return [Boolean] + attr_accessor :fully_decode_reserved_expansion + alias_method :fully_decode_reserved_expansion?, :fully_decode_reserved_expansion + + # A list of HTTP configuration rules that apply to individual API methods. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fully_decode_reserved_expansion = args[:fully_decode_reserved_expansion] if args.key?(:fully_decode_reserved_expansion) + @rules = args[:rules] if args.key?(:rules) + end + end + + # `HttpRule` defines the mapping of an RPC method to one or more HTTP + # REST API methods. The mapping specifies how different portions of the RPC + # request message are mapped to URL path, URL query parameters, and + # HTTP request body. The mapping is typically specified as an + # `google.api.http` annotation on the RPC method, + # see "google/api/annotations.proto" for details. + # The mapping consists of a field specifying the path template and + # method kind. The path template can refer to fields in the request + # message, as in the example below which describes a REST GET + # operation on a resource collection of messages: + # service Messaging ` + # rpc GetMessage(GetMessageRequest) returns (Message) ` + # option (google.api.http).get = "/v1/messages/`message_id`/`sub. + # subfield`"; + # ` + # ` + # message GetMessageRequest ` + # message SubMessage ` + # string subfield = 1; + # ` + # string message_id = 1; // mapped to the URL + # SubMessage sub = 2; // `sub.subfield` is url-mapped + # ` + # message Message ` + # string text = 1; // content of the resource + # ` + # The same http annotation can alternatively be expressed inside the + # `GRPC API Configuration` YAML file. + # http: + # rules: + # - selector: .Messaging.GetMessage + # get: /v1/messages/`message_id`/`sub.subfield` + # This definition enables an automatic, bidrectional mapping of HTTP + # JSON to RPC. Example: + # HTTP | RPC + # -----|----- + # `GET /v1/messages/123456/foo` | `GetMessage(message_id: "123456" sub: + # SubMessage(subfield: "foo"))` + # In general, not only fields but also field paths can be referenced + # from a path pattern. Fields mapped to the path pattern cannot be + # repeated and must have a primitive (non-message) type. + # Any fields in the request message which are not bound by the path + # pattern automatically become (optional) HTTP query + # parameters. Assume the following definition of the request message: + # service Messaging ` + # rpc GetMessage(GetMessageRequest) returns (Message) ` + # option (google.api.http).get = "/v1/messages/`message_id`"; + # ` + # ` + # message GetMessageRequest ` + # message SubMessage ` + # string subfield = 1; + # ` + # string message_id = 1; // mapped to the URL + # int64 revision = 2; // becomes a parameter + # SubMessage sub = 3; // `sub.subfield` becomes a parameter + # ` + # This enables a HTTP JSON to RPC mapping as below: + # HTTP | RPC + # -----|----- + # `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: + # "123456" revision: 2 sub: SubMessage(subfield: "foo"))` + # Note that fields which are mapped to HTTP parameters must have a + # primitive type or a repeated primitive type. Message types are not + # allowed. In the case of a repeated type, the parameter can be + # repeated in the URL, as in `...?param=A¶m=B`. + # For HTTP method kinds which allow a request body, the `body` field + # specifies the mapping. Consider a REST update method on the + # message resource collection: + # service Messaging ` + # rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` + # option (google.api.http) = ` + # put: "/v1/messages/`message_id`" + # body: "message" + # `; + # ` + # ` + # message UpdateMessageRequest ` + # string message_id = 1; // mapped to the URL + # Message message = 2; // mapped to the body + # ` + # The following HTTP JSON to RPC mapping is enabled, where the + # representation of the JSON in the request body is determined by + # protos JSON encoding: + # HTTP | RPC + # -----|----- + # `PUT /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: " + # 123456" message ` text: "Hi!" `)` + # The special name `*` can be used in the body mapping to define that + # every field not bound by the path template should be mapped to the + # request body. This enables the following alternative definition of + # the update method: + # service Messaging ` + # rpc UpdateMessage(Message) returns (Message) ` + # option (google.api.http) = ` + # put: "/v1/messages/`message_id`" + # body: "*" + # `; + # ` + # ` + # message Message ` + # string message_id = 1; + # string text = 2; + # ` + # The following HTTP JSON to RPC mapping is enabled: + # HTTP | RPC + # -----|----- + # `PUT /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: " + # 123456" text: "Hi!")` + # Note that when using `*` in the body mapping, it is not possible to + # have HTTP parameters, as all fields not bound by the path end in + # the body. This makes this option more rarely used in practice of + # defining REST APIs. The common usage of `*` is in custom methods + # which don't use the URL at all for transferring data. + # It is possible to define multiple HTTP methods for one RPC by using + # the `additional_bindings` option. Example: + # service Messaging ` + # rpc GetMessage(GetMessageRequest) returns (Message) ` + # option (google.api.http) = ` + # get: "/v1/messages/`message_id`" + # additional_bindings ` + # get: "/v1/users/`user_id`/messages/`message_id`" + # ` + # `; + # ` + # ` + # message GetMessageRequest ` + # string message_id = 1; + # string user_id = 2; + # ` + # This enables the following two alternative HTTP JSON to RPC + # mappings: + # HTTP | RPC + # -----|----- + # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")` + # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: " + # 123456")` + # # Rules for HTTP mapping + # The rules for mapping HTTP path, query parameters, and body fields + # to the request message are as follows: + # 1. The `body` field specifies either `*` or a field path, or is + # omitted. If omitted, it indicates there is no HTTP request body. + # 2. Leaf fields (recursive expansion of nested messages in the + # request) can be classified into three types: + # (a) Matched in the URL template. + # (b) Covered by body (if body is `*`, everything except (a) fields; + # else everything under the body field) + # (c) All other fields. + # 3. URL query parameters found in the HTTP request are mapped to (c) fields. + # 4. Any body sent with an HTTP request can contain only (b) fields. + # The syntax of the path template is as follows: + # Template = "/" Segments [ Verb ] ; + # Segments = Segment ` "/" Segment ` ; + # Segment = "*" | "**" | LITERAL | Variable ; + # Variable = "`" FieldPath [ "=" Segments ] "`" ; + # FieldPath = IDENT ` "." IDENT ` ; + # Verb = ":" LITERAL ; + # The syntax `*` matches a single path segment. The syntax `**` matches zero + # or more path segments, which must be the last part of the path except the + # `Verb`. The syntax `LITERAL` matches literal text in the path. + # The syntax `Variable` matches part of the URL path as specified by its + # template. A variable template must not contain other variables. If a variable + # matches a single path segment, its template may be omitted, e.g. ``var`` + # is equivalent to ``var=*``. + # If a variable contains exactly one path segment, such as `"`var`"` or + # `"`var=*`"`, when such a variable is expanded into a URL path, all characters + # except `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the + # Discovery Document as ``var``. + # If a variable contains one or more path segments, such as `"`var=foo/*`"` + # or `"`var=**`"`, when such a variable is expanded into a URL path, all + # characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables + # show up in the Discovery Document as ``+var``. + # NOTE: While the single segment variable matches the semantics of + # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 + # Simple String Expansion, the multi segment variable **does not** match + # RFC 6570 Reserved Expansion. The reason is that the Reserved Expansion + # does not expand special characters like `?` and `#`, which would lead + # to invalid URLs. + # NOTE: the field paths in variables and in the `body` must not refer to + # repeated fields or map fields. + class HttpRule + include Google::Apis::Core::Hashable + + # Additional HTTP bindings for the selector. Nested bindings must + # not contain an `additional_bindings` field themselves (that is, + # the nesting may only be one level deep). + # Corresponds to the JSON property `additionalBindings` + # @return [Array] + attr_accessor :additional_bindings + + # Specifies the permission(s) required for an API element for the overall + # API request to succeed. It is typically used to mark request message fields + # that contain the name of the resource and indicates the permissions that + # will be checked on that resource. + # Corresponds to the JSON property `authorizations` + # @return [Array] + attr_accessor :authorizations + + # The name of the request field whose value is mapped to the HTTP body, or + # `*` for mapping all fields not captured by the path pattern to the HTTP + # body. NOTE: the referred field must not be a repeated field and must be + # present at the top-level of request message type. + # Corresponds to the JSON property `body` + # @return [String] + attr_accessor :body + + # A custom pattern is used for defining custom HTTP verb. + # Corresponds to the JSON property `custom` + # @return [Google::Apis::ServiceconsumermanagementV1::CustomHttpPattern] + attr_accessor :custom + + # Used for deleting a resource. + # Corresponds to the JSON property `delete` + # @return [String] + attr_accessor :delete + + # Used for listing and getting information about resources. + # Corresponds to the JSON property `get` + # @return [String] + attr_accessor :get + + # Defines the Media configuration for a service in case of a download. + # Use this only for Scotty Requests. Do not use this for media support using + # Bytestream, add instead [][google.bytestream.RestByteStream] as an API to + # your configuration for Bytestream methods. + # Corresponds to the JSON property `mediaDownload` + # @return [Google::Apis::ServiceconsumermanagementV1::MediaDownload] + attr_accessor :media_download + + # Defines the Media configuration for a service in case of an upload. + # Use this only for Scotty Requests. Do not use this for media support using + # Bytestream, add instead [][google.bytestream.RestByteStream] as an API to + # your configuration for Bytestream methods. + # Corresponds to the JSON property `mediaUpload` + # @return [Google::Apis::ServiceconsumermanagementV1::MediaUpload] + attr_accessor :media_upload + + # Used for updating a resource. + # Corresponds to the JSON property `patch` + # @return [String] + attr_accessor :patch + + # Used for creating a resource. + # Corresponds to the JSON property `post` + # @return [String] + attr_accessor :post + + # Used for updating a resource. + # Corresponds to the JSON property `put` + # @return [String] + attr_accessor :put + + # The name of the response field whose value is mapped to the HTTP body of + # response. Other response fields are ignored. This field is optional. When + # not set, the response message will be used as HTTP body of response. + # NOTE: the referred field must be not a repeated field and must be present + # at the top-level of response message type. + # Corresponds to the JSON property `responseBody` + # @return [String] + attr_accessor :response_body + + # DO NOT USE. This is an experimental field. + # Optional. The REST collection name is by default derived from the URL + # pattern. If specified, this field overrides the default collection name. + # Example: + # rpc AddressesAggregatedList(AddressesAggregatedListRequest) + # returns (AddressesAggregatedListResponse) ` + # option (google.api.http) = ` + # get: "/v1/projects/`project_id`/aggregated/addresses" + # rest_collection: "projects.addresses" + # `; + # ` + # This method has the automatically derived collection name + # "projects.aggregated". Because, semantically, this rpc is actually an + # operation on the "projects.addresses" collection, the `rest_collection` + # field is configured to override the derived collection name. + # Corresponds to the JSON property `restCollection` + # @return [String] + attr_accessor :rest_collection + + # DO NOT USE. This is an experimental field. + # Optional. The rest method name is by default derived from the URL + # pattern. If specified, this field overrides the default method name. + # Example: + # rpc CreateResource(CreateResourceRequest) + # returns (CreateResourceResponse) ` + # option (google.api.http) = ` + # post: "/v1/resources", + # body: "resource", + # rest_method_name: "insert" + # `; + # ` + # This method has the automatically derived rest method name + # "create", but for backwards compatibility with apiary, it is specified as + # insert. + # Corresponds to the JSON property `restMethodName` + # @return [String] + attr_accessor :rest_method_name + + # Selects methods to which this rule applies. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @additional_bindings = args[:additional_bindings] if args.key?(:additional_bindings) + @authorizations = args[:authorizations] if args.key?(:authorizations) + @body = args[:body] if args.key?(:body) + @custom = args[:custom] if args.key?(:custom) + @delete = args[:delete] if args.key?(:delete) + @get = args[:get] if args.key?(:get) + @media_download = args[:media_download] if args.key?(:media_download) + @media_upload = args[:media_upload] if args.key?(:media_upload) + @patch = args[:patch] if args.key?(:patch) + @post = args[:post] if args.key?(:post) + @put = args[:put] if args.key?(:put) + @response_body = args[:response_body] if args.key?(:response_body) + @rest_collection = args[:rest_collection] if args.key?(:rest_collection) + @rest_method_name = args[:rest_method_name] if args.key?(:rest_method_name) + @selector = args[:selector] if args.key?(:selector) + end + end + + # A description of a label. + class LabelDescriptor + include Google::Apis::Core::Hashable + + # A human-readable description for the label. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The label key. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # The type of data that can be assigned to the label. + # Corresponds to the JSON property `valueType` + # @return [String] + attr_accessor :value_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @key = args[:key] if args.key?(:key) + @value_type = args[:value_type] if args.key?(:value_type) + end + end + + # The response message for Operations.ListOperations. + class ListOperationsResponse + include Google::Apis::Core::Hashable + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of operations that matches the specified filter in the request. + # Corresponds to the JSON property `operations` + # @return [Array] + attr_accessor :operations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @operations = args[:operations] if args.key?(:operations) + end + end + + # Response for the list request. + class ListTenancyUnitsResponse + include Google::Apis::Core::Hashable + + # Pagination token for large results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Tenancy Units matching the request. + # Corresponds to the JSON property `tenancyUnits` + # @return [Array] + attr_accessor :tenancy_units + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @tenancy_units = args[:tenancy_units] if args.key?(:tenancy_units) + end + end + + # A description of a log type. Example in YAML format: + # - name: library.googleapis.com/activity_history + # description: The history of borrowing and returning library items. + # display_name: Activity + # labels: + # - key: /customer_id + # description: Identifier of a library customer + class LogDescriptor + include Google::Apis::Core::Hashable + + # A human-readable description of this log. This information appears in + # the documentation and can contain details. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The human-readable name for this log. This information appears on + # the user interface and should be concise. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The set of labels that are available to describe a specific log entry. + # Runtime requests that contain labels not specified here are + # considered invalid. + # Corresponds to the JSON property `labels` + # @return [Array] + attr_accessor :labels + + # The name of the log. It must be less than 512 characters long and can + # include the following characters: upper- and lower-case alphanumeric + # characters [A-Za-z0-9], and punctuation characters including + # slash, underscore, hyphen, period [/_-.]. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + end + end + + # Logging configuration of the service. + # The following example shows how to configure logs to be sent to the + # producer and consumer projects. In the example, the `activity_history` + # log is sent to both the producer and consumer projects, whereas the + # `purchase_history` log is only sent to the producer project. + # monitored_resources: + # - type: library.googleapis.com/branch + # labels: + # - key: /city + # description: The city where the library branch is located in. + # - key: /name + # description: The name of the branch. + # logs: + # - name: activity_history + # labels: + # - key: /customer_id + # - name: purchase_history + # logging: + # producer_destinations: + # - monitored_resource: library.googleapis.com/branch + # logs: + # - activity_history + # - purchase_history + # consumer_destinations: + # - monitored_resource: library.googleapis.com/branch + # logs: + # - activity_history + class Logging + include Google::Apis::Core::Hashable + + # Logging configurations for sending logs to the consumer project. + # There can be multiple consumer destinations, each one must have a + # different monitored resource type. A log can be used in at most + # one consumer destination. + # Corresponds to the JSON property `consumerDestinations` + # @return [Array] + attr_accessor :consumer_destinations + + # Logging configurations for sending logs to the producer project. + # There can be multiple producer destinations, each one must have a + # different monitored resource type. A log can be used in at most + # one producer destination. + # Corresponds to the JSON property `producerDestinations` + # @return [Array] + attr_accessor :producer_destinations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @consumer_destinations = args[:consumer_destinations] if args.key?(:consumer_destinations) + @producer_destinations = args[:producer_destinations] if args.key?(:producer_destinations) + end + end + + # Configuration of a specific logging destination (the producer project + # or the consumer project). + class LoggingDestination + include Google::Apis::Core::Hashable + + # Names of the logs to be sent to this destination. Each name must + # be defined in the Service.logs section. If the log name is + # not a domain scoped name, it will be automatically prefixed with + # the service name followed by "/". + # Corresponds to the JSON property `logs` + # @return [Array] + attr_accessor :logs + + # The monitored resource type. The type must be defined in the + # Service.monitored_resources section. + # Corresponds to the JSON property `monitoredResource` + # @return [String] + attr_accessor :monitored_resource + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @logs = args[:logs] if args.key?(:logs) + @monitored_resource = args[:monitored_resource] if args.key?(:monitored_resource) + end + end + + # Defines the Media configuration for a service in case of a download. + # Use this only for Scotty Requests. Do not use this for media support using + # Bytestream, add instead [][google.bytestream.RestByteStream] as an API to + # your configuration for Bytestream methods. + class MediaDownload + include Google::Apis::Core::Hashable + + # A boolean that determines whether a notification for the completion of a + # download should be sent to the backend. + # Corresponds to the JSON property `completeNotification` + # @return [Boolean] + attr_accessor :complete_notification + alias_method :complete_notification?, :complete_notification + + # DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED. + # Specify name of the download service if one is used for download. + # Corresponds to the JSON property `downloadService` + # @return [String] + attr_accessor :download_service + + # Name of the Scotty dropzone to use for the current API. + # Corresponds to the JSON property `dropzone` + # @return [String] + attr_accessor :dropzone + + # Whether download is enabled. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + # Optional maximum acceptable size for direct download. + # The size is specified in bytes. + # Corresponds to the JSON property `maxDirectDownloadSize` + # @return [Fixnum] + attr_accessor :max_direct_download_size + + # A boolean that determines if direct download from ESF should be used for + # download of this media. + # Corresponds to the JSON property `useDirectDownload` + # @return [Boolean] + attr_accessor :use_direct_download + alias_method :use_direct_download?, :use_direct_download + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @complete_notification = args[:complete_notification] if args.key?(:complete_notification) + @download_service = args[:download_service] if args.key?(:download_service) + @dropzone = args[:dropzone] if args.key?(:dropzone) + @enabled = args[:enabled] if args.key?(:enabled) + @max_direct_download_size = args[:max_direct_download_size] if args.key?(:max_direct_download_size) + @use_direct_download = args[:use_direct_download] if args.key?(:use_direct_download) + end + end + + # Defines the Media configuration for a service in case of an upload. + # Use this only for Scotty Requests. Do not use this for media support using + # Bytestream, add instead [][google.bytestream.RestByteStream] as an API to + # your configuration for Bytestream methods. + class MediaUpload + include Google::Apis::Core::Hashable + + # A boolean that determines whether a notification for the completion of an + # upload should be sent to the backend. These notifications will not be seen + # by the client and will not consume quota. + # Corresponds to the JSON property `completeNotification` + # @return [Boolean] + attr_accessor :complete_notification + alias_method :complete_notification?, :complete_notification + + # Name of the Scotty dropzone to use for the current API. + # Corresponds to the JSON property `dropzone` + # @return [String] + attr_accessor :dropzone + + # Whether upload is enabled. + # Corresponds to the JSON property `enabled` + # @return [Boolean] + attr_accessor :enabled + alias_method :enabled?, :enabled + + # Optional maximum acceptable size for an upload. + # The size is specified in bytes. + # Corresponds to the JSON property `maxSize` + # @return [Fixnum] + attr_accessor :max_size + + # An array of mimetype patterns. Esf will only accept uploads that match one + # of the given patterns. + # Corresponds to the JSON property `mimeTypes` + # @return [Array] + attr_accessor :mime_types + + # Whether to receive a notification for progress changes of media upload. + # Corresponds to the JSON property `progressNotification` + # @return [Boolean] + attr_accessor :progress_notification + alias_method :progress_notification?, :progress_notification + + # Whether to receive a notification on the start of media upload. + # Corresponds to the JSON property `startNotification` + # @return [Boolean] + attr_accessor :start_notification + alias_method :start_notification?, :start_notification + + # DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED. + # Specify name of the upload service if one is used for upload. + # Corresponds to the JSON property `uploadService` + # @return [String] + attr_accessor :upload_service + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @complete_notification = args[:complete_notification] if args.key?(:complete_notification) + @dropzone = args[:dropzone] if args.key?(:dropzone) + @enabled = args[:enabled] if args.key?(:enabled) + @max_size = args[:max_size] if args.key?(:max_size) + @mime_types = args[:mime_types] if args.key?(:mime_types) + @progress_notification = args[:progress_notification] if args.key?(:progress_notification) + @start_notification = args[:start_notification] if args.key?(:start_notification) + @upload_service = args[:upload_service] if args.key?(:upload_service) + end + end + + # Method represents a method of an API interface. + class MethodProp + include Google::Apis::Core::Hashable + + # The simple name of this method. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Any metadata attached to the method. + # Corresponds to the JSON property `options` + # @return [Array] + attr_accessor :options + + # If true, the request is streamed. + # Corresponds to the JSON property `requestStreaming` + # @return [Boolean] + attr_accessor :request_streaming + alias_method :request_streaming?, :request_streaming + + # A URL of the input message type. + # Corresponds to the JSON property `requestTypeUrl` + # @return [String] + attr_accessor :request_type_url + + # If true, the response is streamed. + # Corresponds to the JSON property `responseStreaming` + # @return [Boolean] + attr_accessor :response_streaming + alias_method :response_streaming?, :response_streaming + + # The URL of the output message type. + # Corresponds to the JSON property `responseTypeUrl` + # @return [String] + attr_accessor :response_type_url + + # The source syntax of this method. + # Corresponds to the JSON property `syntax` + # @return [String] + attr_accessor :syntax + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @options = args[:options] if args.key?(:options) + @request_streaming = args[:request_streaming] if args.key?(:request_streaming) + @request_type_url = args[:request_type_url] if args.key?(:request_type_url) + @response_streaming = args[:response_streaming] if args.key?(:response_streaming) + @response_type_url = args[:response_type_url] if args.key?(:response_type_url) + @syntax = args[:syntax] if args.key?(:syntax) + end + end + + # Defines a metric type and its schema. Once a metric descriptor is created, + # deleting or altering it stops data collection and makes the metric type's + # existing data unusable. + class MetricDescriptor + include Google::Apis::Core::Hashable + + # A detailed description of the metric, which can be used in documentation. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # A concise name for the metric, which can be displayed in user interfaces. + # Use sentence case without an ending period, for example "Request count". + # This field is optional but it is recommended to be set for any metrics + # associated with user-visible concepts, such as Quota. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The set of labels that can be used to describe a specific + # instance of this metric type. For example, the + # `appengine.googleapis.com/http/server/response_latencies` metric + # type has a label for the HTTP response code, `response_code`, so + # you can look at latencies for successful responses or just + # for responses that failed. + # Corresponds to the JSON property `labels` + # @return [Array] + attr_accessor :labels + + # Whether the metric records instantaneous values, changes to a value, etc. + # Some combinations of `metric_kind` and `value_type` might not be supported. + # Corresponds to the JSON property `metricKind` + # @return [String] + attr_accessor :metric_kind + + # The resource name of the metric descriptor. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The metric type, including its DNS name prefix. The type is not + # URL-encoded. All user-defined custom metric types have the DNS name + # `custom.googleapis.com`. Metric types should use a natural hierarchical + # grouping. For example: + # "custom.googleapis.com/invoice/paid/amount" + # "appengine.googleapis.com/http/server/response_latencies" + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # The unit in which the metric value is reported. It is only applicable + # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The + # supported units are a subset of [The Unified Code for Units of + # Measure](http://unitsofmeasure.org/ucum.html) standard: + # **Basic units (UNIT)** + # * `bit` bit + # * `By` byte + # * `s` second + # * `min` minute + # * `h` hour + # * `d` day + # **Prefixes (PREFIX)** + # * `k` kilo (10**3) + # * `M` mega (10**6) + # * `G` giga (10**9) + # * `T` tera (10**12) + # * `P` peta (10**15) + # * `E` exa (10**18) + # * `Z` zetta (10**21) + # * `Y` yotta (10**24) + # * `m` milli (10**-3) + # * `u` micro (10**-6) + # * `n` nano (10**-9) + # * `p` pico (10**-12) + # * `f` femto (10**-15) + # * `a` atto (10**-18) + # * `z` zepto (10**-21) + # * `y` yocto (10**-24) + # * `Ki` kibi (2**10) + # * `Mi` mebi (2**20) + # * `Gi` gibi (2**30) + # * `Ti` tebi (2**40) + # **Grammar** + # The grammar includes the dimensionless unit `1`, such as `1/s`. + # The grammar also includes these connectors: + # * `/` division (as an infix operator, e.g. `1/s`). + # * `.` multiplication (as an infix operator, e.g. `GBy.d`) + # The grammar for a unit is as follows: + # Expression = Component ` "." Component ` ` "/" Component ` ; + # Component = [ PREFIX ] UNIT [ Annotation ] + # | Annotation + # | "1" + # ; + # Annotation = "`" NAME "`" ; + # Notes: + # * `Annotation` is just a comment if it follows a `UNIT` and is + # equivalent to `1` if it is used alone. For examples, + # ``requests`/s == 1/s`, `By`transmitted`/s == By/s`. + # * `NAME` is a sequence of non-blank printable ASCII characters not + # containing '`' or '`'. + # Corresponds to the JSON property `unit` + # @return [String] + attr_accessor :unit + + # Whether the measurement is an integer, a floating-point number, etc. + # Some combinations of `metric_kind` and `value_type` might not be supported. + # Corresponds to the JSON property `valueType` + # @return [String] + attr_accessor :value_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @labels = args[:labels] if args.key?(:labels) + @metric_kind = args[:metric_kind] if args.key?(:metric_kind) + @name = args[:name] if args.key?(:name) + @type = args[:type] if args.key?(:type) + @unit = args[:unit] if args.key?(:unit) + @value_type = args[:value_type] if args.key?(:value_type) + end + end + + # Bind API methods to metrics. Binding a method to a metric causes that + # metric's configured quota behaviors to apply to the method call. + class MetricRule + include Google::Apis::Core::Hashable + + # Metrics to update when the selected methods are called, and the associated + # cost applied to each metric. + # The key of the map is the metric name, and the values are the amount + # increased for the metric against which the quota limits are defined. + # The value must not be negative. + # Corresponds to the JSON property `metricCosts` + # @return [Hash] + attr_accessor :metric_costs + + # Selects the methods to which this rule applies. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metric_costs = args[:metric_costs] if args.key?(:metric_costs) + @selector = args[:selector] if args.key?(:selector) + end + end + + # Declares an API Interface to be included in this interface. The including + # interface must redeclare all the methods from the included interface, but + # documentation and options are inherited as follows: + # - If after comment and whitespace stripping, the documentation + # string of the redeclared method is empty, it will be inherited + # from the original method. + # - Each annotation belonging to the service config (http, + # visibility) which is not set in the redeclared method will be + # inherited. + # - If an http annotation is inherited, the path pattern will be + # modified as follows. Any version prefix will be replaced by the + # version of the including interface plus the root path if + # specified. + # Example of a simple mixin: + # package google.acl.v1; + # service AccessControl ` + # // Get the underlying ACL object. + # rpc GetAcl(GetAclRequest) returns (Acl) ` + # option (google.api.http).get = "/v1/`resource=**`:getAcl"; + # ` + # ` + # package google.storage.v2; + # service Storage ` + # // rpc GetAcl(GetAclRequest) returns (Acl); + # // Get a data record. + # rpc GetData(GetDataRequest) returns (Data) ` + # option (google.api.http).get = "/v2/`resource=**`"; + # ` + # ` + # Example of a mixin configuration: + # apis: + # - name: google.storage.v2.Storage + # mixins: + # - name: google.acl.v1.AccessControl + # The mixin construct implies that all methods in `AccessControl` are + # also declared with same name and request/response types in + # `Storage`. A documentation generator or annotation processor will + # see the effective `Storage.GetAcl` method after inherting + # documentation and annotations as follows: + # service Storage ` + # // Get the underlying ACL object. + # rpc GetAcl(GetAclRequest) returns (Acl) ` + # option (google.api.http).get = "/v2/`resource=**`:getAcl"; + # ` + # ... + # ` + # Note how the version in the path pattern changed from `v1` to `v2`. + # If the `root` field in the mixin is specified, it should be a + # relative path under which inherited HTTP paths are placed. Example: + # apis: + # - name: google.storage.v2.Storage + # mixins: + # - name: google.acl.v1.AccessControl + # root: acls + # This implies the following inherited HTTP annotation: + # service Storage ` + # // Get the underlying ACL object. + # rpc GetAcl(GetAclRequest) returns (Acl) ` + # option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; + # ` + # ... + # ` + class Mixin + include Google::Apis::Core::Hashable + + # The fully qualified name of the interface which is included. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # If non-empty specifies a path under which inherited HTTP paths + # are rooted. + # Corresponds to the JSON property `root` + # @return [String] + attr_accessor :root + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @root = args[:root] if args.key?(:root) + end + end + + # An object that describes the schema of a MonitoredResource object using a + # type name and a set of labels. For example, the monitored resource + # descriptor for Google Compute Engine VM instances has a type of + # `"gce_instance"` and specifies the use of the labels `"instance_id"` and + # `"zone"` to identify particular VM instances. + # Different APIs can support different monitored resource types. APIs generally + # provide a `list` method that returns the monitored resource descriptors used + # by the API. + class MonitoredResourceDescriptor + include Google::Apis::Core::Hashable + + # Optional. A detailed description of the monitored resource type that might + # be used in documentation. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Optional. A concise name for the monitored resource type that might be + # displayed in user interfaces. It should be a Title Cased Noun Phrase, + # without any article or other determiners. For example, + # `"Google Cloud SQL Database"`. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Required. A set of labels used to describe instances of this monitored + # resource type. For example, an individual Google Cloud SQL database is + # identified by values for the labels `"database_id"` and `"zone"`. + # Corresponds to the JSON property `labels` + # @return [Array] + attr_accessor :labels + + # Optional. The resource name of the monitored resource descriptor: + # `"projects/`project_id`/monitoredResourceDescriptors/`type`"` where + # `type` is the value of the `type` field in this object and + # `project_id` is a project ID that provides API-specific context for + # accessing the type. APIs that do not use project information can use the + # resource name format `"monitoredResourceDescriptors/`type`"`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Required. The monitored resource type. For example, the type + # `"cloudsql_database"` represents databases in Google Cloud SQL. + # The maximum length of this value is 256 characters. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @labels = args[:labels] if args.key?(:labels) + @name = args[:name] if args.key?(:name) + @type = args[:type] if args.key?(:type) + end + end + + # Monitoring configuration of the service. + # The example below shows how to configure monitored resources and metrics + # for monitoring. In the example, a monitored resource and two metrics are + # defined. The `library.googleapis.com/book/returned_count` metric is sent + # to both producer and consumer projects, whereas the + # `library.googleapis.com/book/overdue_count` metric is only sent to the + # consumer project. + # monitored_resources: + # - type: library.googleapis.com/branch + # labels: + # - key: /city + # description: The city where the library branch is located in. + # - key: /name + # description: The name of the branch. + # metrics: + # - name: library.googleapis.com/book/returned_count + # metric_kind: DELTA + # value_type: INT64 + # labels: + # - key: /customer_id + # - name: library.googleapis.com/book/overdue_count + # metric_kind: GAUGE + # value_type: INT64 + # labels: + # - key: /customer_id + # monitoring: + # producer_destinations: + # - monitored_resource: library.googleapis.com/branch + # metrics: + # - library.googleapis.com/book/returned_count + # consumer_destinations: + # - monitored_resource: library.googleapis.com/branch + # metrics: + # - library.googleapis.com/book/returned_count + # - library.googleapis.com/book/overdue_count + class Monitoring + include Google::Apis::Core::Hashable + + # Monitoring configurations for sending metrics to the consumer project. + # There can be multiple consumer destinations, each one must have a + # different monitored resource type. A metric can be used in at most + # one consumer destination. + # Corresponds to the JSON property `consumerDestinations` + # @return [Array] + attr_accessor :consumer_destinations + + # Monitoring configurations for sending metrics to the producer project. + # There can be multiple producer destinations, each one must have a + # different monitored resource type. A metric can be used in at most + # one producer destination. + # Corresponds to the JSON property `producerDestinations` + # @return [Array] + attr_accessor :producer_destinations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @consumer_destinations = args[:consumer_destinations] if args.key?(:consumer_destinations) + @producer_destinations = args[:producer_destinations] if args.key?(:producer_destinations) + end + end + + # Configuration of a specific monitoring destination (the producer project + # or the consumer project). + class MonitoringDestination + include Google::Apis::Core::Hashable + + # Names of the metrics to report to this monitoring destination. + # Each name must be defined in Service.metrics section. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # The monitored resource type. The type must be defined in + # Service.monitored_resources section. + # Corresponds to the JSON property `monitoredResource` + # @return [String] + attr_accessor :monitored_resource + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metrics = args[:metrics] if args.key?(:metrics) + @monitored_resource = args[:monitored_resource] if args.key?(:monitored_resource) + end + end + + # OAuth scopes are a way to define data and permissions on data. For example, + # there are scopes defined for "Read-only access to Google Calendar" and + # "Access to Cloud Platform". Users can consent to a scope for an application, + # giving it permission to access that data on their behalf. + # OAuth scope specifications should be fairly coarse grained; a user will need + # to see and understand the text description of what your scope means. + # In most cases: use one or at most two OAuth scopes for an entire family of + # products. If your product has multiple APIs, you should probably be sharing + # the OAuth scope across all of those APIs. + # When you need finer grained OAuth consent screens: talk with your product + # management about how developers will use them in practice. + # Please note that even though each of the canonical scopes is enough for a + # request to be accepted and passed to the backend, a request can still fail + # due to the backend requiring additional scopes or permissions. + class OAuthRequirements + include Google::Apis::Core::Hashable + + # The list of publicly documented OAuth scopes that are allowed access. An + # OAuth token containing any of these scopes will be accepted. + # Example: + # canonical_scopes: https://www.googleapis.com/auth/calendar, + # https://www.googleapis.com/auth/calendar.read + # Corresponds to the JSON property `canonicalScopes` + # @return [String] + attr_accessor :canonical_scopes + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @canonical_scopes = args[:canonical_scopes] if args.key?(:canonical_scopes) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class Operation + include Google::Apis::Core::Hashable + + # If the value is `false`, it means the operation is still in progress. + # If `true`, the operation is completed, and either `error` or `response` is + # available. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by + # [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error message, + # and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + # Corresponds to the JSON property `error` + # @return [Google::Apis::ServiceconsumermanagementV1::Status] + attr_accessor :error + + # Service-specific metadata associated with the operation. It typically + # contains progress information and common metadata such as create time. + # Some services might not provide such metadata. Any method that returns a + # long-running operation should document the metadata type, if any. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # The server-assigned name, which is only unique within the same service that + # originally returns it. If you use the default HTTP mapping, the + # `name` should have the format of `operations/some/unique/name`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is + # `google.protobuf.Empty`. If the original method is standard + # `Get`/`Create`/`Update`, the response should be the resource. For other + # methods, the response should have the type `XxxResponse`, where `Xxx` + # is the original method name. For example, if the original method name + # is `TakeSnapshot()`, the inferred response type is + # `TakeSnapshotResponse`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @response = args[:response] if args.key?(:response) + end + end + + # A protocol buffer option, which can be attached to a message, field, + # enumeration, etc. + class Option + include Google::Apis::Core::Hashable + + # The option's name. For protobuf built-in options (options defined in + # descriptor.proto), this is the short name. For example, `"map_entry"`. + # For custom options, it should be the fully-qualified name. For example, + # `"google.api.http"`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The option's value packed in an Any message. If the value is a primitive, + # the corresponding wrapper type defined in google/protobuf/wrappers.proto + # should be used. If the value is an enum, it should be stored as an int32 + # value using the google.protobuf.Int32Value type. + # Corresponds to the JSON property `value` + # @return [Hash] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @value = args[:value] if args.key?(:value) + end + end + + # Represents a documentation page. A page can contain subpages to represent + # nested documentation set structure. + class Page + include Google::Apis::Core::Hashable + + # The Markdown content of the page. You can use (== include `path` ==&# + # 41; + # to include content from a Markdown file. + # Corresponds to the JSON property `content` + # @return [String] + attr_accessor :content + + # The name of the page. It will be used as an identity of the page to + # generate URI of the page, text of the link to this page in navigation, + # etc. The full page name (start from the root page name to this page + # concatenated with `.`) can be used as reference to the page in your + # documentation. For example: + # 
pages:
+        # - name: Tutorial
+        # content: (== include tutorial.md ==)
+        # subpages:
+        # - name: Java
+        # content: (== include tutorial_java.md ==)
+        #
+ # You can reference `Java` page using Markdown reference link syntax: + # `Java`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Subpages of this page. The order of subpages specified here will be + # honored in the generated docset. + # Corresponds to the JSON property `subpages` + # @return [Array] + attr_accessor :subpages + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content = args[:content] if args.key?(:content) + @name = args[:name] if args.key?(:name) + @subpages = args[:subpages] if args.key?(:subpages) + end + end + + # Translates to IAM Policy bindings (without auditing at this level) + class PolicyBinding + include Google::Apis::Core::Hashable + + # Uses the same format as in IAM policy. + # `member` must include both prefix and id. E.g., `user:`emailId``, + # `serviceAccount:`emailId``, `group:`emailId``. + # Corresponds to the JSON property `members` + # @return [Array] + attr_accessor :members + + # Role. (https://cloud.google.com/iam/docs/understanding-roles) + # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + # Corresponds to the JSON property `role` + # @return [String] + attr_accessor :role + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @members = args[:members] if args.key?(:members) + @role = args[:role] if args.key?(:role) + end + end + + # Quota configuration helps to achieve fairness and budgeting in service + # usage. + # The quota configuration works this way: + # - The service configuration defines a set of metrics. + # - For API calls, the quota.metric_rules maps methods to metrics with + # corresponding costs. + # - The quota.limits defines limits on the metrics, which will be used for + # quota checks at runtime. + # An example quota configuration in yaml format: + # quota: + # - name: apiWriteQpsPerProject + # metric: library.googleapis.com/write_calls + # unit: "1/min/`project`" # rate limit for consumer projects + # values: + # STANDARD: 10000 + # # The metric rules bind all methods to the read_calls metric, + # # except for the UpdateBook and DeleteBook methods. These two methods + # # are mapped to the write_calls metric, with the UpdateBook method + # # consuming at twice rate as the DeleteBook method. + # metric_rules: + # - selector: "*" + # metric_costs: + # library.googleapis.com/read_calls: 1 + # - selector: google.example.library.v1.LibraryService.UpdateBook + # metric_costs: + # library.googleapis.com/write_calls: 2 + # - selector: google.example.library.v1.LibraryService.DeleteBook + # metric_costs: + # library.googleapis.com/write_calls: 1 + # Corresponding Metric definition: + # metrics: + # - name: library.googleapis.com/read_calls + # display_name: Read requests + # metric_kind: DELTA + # value_type: INT64 + # - name: library.googleapis.com/write_calls + # display_name: Write requests + # metric_kind: DELTA + # value_type: INT64 + class Quota + include Google::Apis::Core::Hashable + + # List of `QuotaLimit` definitions for the service. + # Corresponds to the JSON property `limits` + # @return [Array] + attr_accessor :limits + + # List of `MetricRule` definitions, each one mapping a selected method to one + # or more metrics. + # Corresponds to the JSON property `metricRules` + # @return [Array] + attr_accessor :metric_rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @limits = args[:limits] if args.key?(:limits) + @metric_rules = args[:metric_rules] if args.key?(:metric_rules) + end + end + + # `QuotaLimit` defines a specific limit that applies over a specified duration + # for a limit type. There can be at most one limit for a duration and limit + # type combination defined within a `QuotaGroup`. + class QuotaLimit + include Google::Apis::Core::Hashable + + # Default number of tokens that can be consumed during the specified + # duration. This is the number of tokens assigned when a client + # application developer activates the service for his/her project. + # Specifying a value of 0 will block all requests. This can be used if you + # are provisioning quota to selected consumers and blocking others. + # Similarly, a value of -1 will indicate an unlimited quota. No other + # negative values are allowed. + # Used by group-based quotas only. + # Corresponds to the JSON property `defaultLimit` + # @return [Fixnum] + attr_accessor :default_limit + + # Optional. User-visible, extended description for this quota limit. + # Should be used only when more context is needed to understand this limit + # than provided by the limit's display name (see: `display_name`). + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # User-visible display name for this limit. + # Optional. If not set, the UI will provide a default display name based on + # the quota configuration. This field can be used to override the default + # display name generated from the configuration. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Duration of this limit in textual notation. Example: "100s", "24h", "1d". + # For duration longer than a day, only multiple of days is supported. We + # support only "100s" and "1d" for now. Additional support will be added in + # the future. "0" indicates indefinite duration. + # Used by group-based quotas only. + # Corresponds to the JSON property `duration` + # @return [String] + attr_accessor :duration + + # Free tier value displayed in the Developers Console for this limit. + # The free tier is the number of tokens that will be subtracted from the + # billed amount when billing is enabled. + # This field can only be set on a limit with duration "1d", in a billable + # group; it is invalid on any other limit. If this field is not set, it + # defaults to 0, indicating that there is no free tier for this service. + # Used by group-based quotas only. + # Corresponds to the JSON property `freeTier` + # @return [Fixnum] + attr_accessor :free_tier + + # Maximum number of tokens that can be consumed during the specified + # duration. Client application developers can override the default limit up + # to this maximum. If specified, this value cannot be set to a value less + # than the default limit. If not specified, it is set to the default limit. + # To allow clients to apply overrides with no upper bound, set this to -1, + # indicating unlimited maximum quota. + # Used by group-based quotas only. + # Corresponds to the JSON property `maxLimit` + # @return [Fixnum] + attr_accessor :max_limit + + # The name of the metric this quota limit applies to. The quota limits with + # the same metric will be checked together during runtime. The metric must be + # defined within the service config. + # Corresponds to the JSON property `metric` + # @return [String] + attr_accessor :metric + + # Name of the quota limit. + # The name must be provided, and it must be unique within the service. The + # name can only include alphanumeric characters as well as '-'. + # The maximum length of the limit name is 64 characters. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Specify the unit of the quota limit. It uses the same syntax as + # Metric.unit. The supported unit kinds are determined by the quota + # backend system. + # Here are some examples: + # * "1/min/`project`" for quota per minute per project. + # Note: the order of unit components is insignificant. + # The "1" at the beginning is required to follow the metric unit syntax. + # Corresponds to the JSON property `unit` + # @return [String] + attr_accessor :unit + + # Tiered limit values. You must specify this as a key:value pair, with an + # integer value that is the maximum number of requests allowed for the + # specified unit. Currently only STANDARD is supported. + # Corresponds to the JSON property `values` + # @return [Hash] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @default_limit = args[:default_limit] if args.key?(:default_limit) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @duration = args[:duration] if args.key?(:duration) + @free_tier = args[:free_tier] if args.key?(:free_tier) + @max_limit = args[:max_limit] if args.key?(:max_limit) + @metric = args[:metric] if args.key?(:metric) + @name = args[:name] if args.key?(:name) + @unit = args[:unit] if args.key?(:unit) + @values = args[:values] if args.key?(:values) + end + end + + # Request message to remove tenant project resource from the tenancy unit. + class RemoveTenantProjectRequest + include Google::Apis::Core::Hashable + + # Tag of the resource within the tenancy unit. + # Corresponds to the JSON property `tag` + # @return [String] + attr_accessor :tag + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @tag = args[:tag] if args.key?(:tag) + end + end + + # Response for the search query. + class SearchTenancyUnitsResponse + include Google::Apis::Core::Hashable + + # Pagination token for large results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # Tenancy Units matching the request. + # Corresponds to the JSON property `tenancyUnits` + # @return [Array] + attr_accessor :tenancy_units + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @tenancy_units = args[:tenancy_units] if args.key?(:tenancy_units) + end + end + + # `Service` is the root object of Google service configuration schema. It + # describes basic information about a service, such as the name and the + # title, and delegates other aspects to sub-sections. Each sub-section is + # either a proto message or a repeated proto message that configures a + # specific aspect, such as auth. See each proto message definition for details. + # Example: + # type: google.api.Service + # config_version: 3 + # name: calendar.googleapis.com + # title: Google Calendar API + # apis: + # - name: google.calendar.v3.Calendar + # authentication: + # providers: + # - id: google_calendar_auth + # jwks_uri: https://www.googleapis.com/oauth2/v1/certs + # issuer: https://securetoken.google.com + # rules: + # - selector: "*" + # requirements: + # provider_id: google_calendar_auth + class Service + include Google::Apis::Core::Hashable + + # A list of API interfaces exported by this service. Only the `name` field + # of the google.protobuf.Api needs to be provided by the configuration + # author, as the remaining fields will be derived from the IDL during the + # normalization process. It is an error to specify an API interface here + # which cannot be resolved against the associated IDL files. + # Corresponds to the JSON property `apis` + # @return [Array] + attr_accessor :apis + + # `Authentication` defines the authentication configuration for an API. + # Example for an API targeted for external use: + # name: calendar.googleapis.com + # authentication: + # providers: + # - id: google_calendar_auth + # jwks_uri: https://www.googleapis.com/oauth2/v1/certs + # issuer: https://securetoken.google.com + # rules: + # - selector: "*" + # requirements: + # provider_id: google_calendar_auth + # Corresponds to the JSON property `authentication` + # @return [Google::Apis::ServiceconsumermanagementV1::Authentication] + attr_accessor :authentication + + # `Backend` defines the backend configuration for a service. + # Corresponds to the JSON property `backend` + # @return [Google::Apis::ServiceconsumermanagementV1::Backend] + attr_accessor :backend + + # Billing related configuration of the service. + # The following example shows how to configure monitored resources and metrics + # for billing: + # monitored_resources: + # - type: library.googleapis.com/branch + # labels: + # - key: /city + # description: The city where the library branch is located in. + # - key: /name + # description: The name of the branch. + # metrics: + # - name: library.googleapis.com/book/borrowed_count + # metric_kind: DELTA + # value_type: INT64 + # billing: + # consumer_destinations: + # - monitored_resource: library.googleapis.com/branch + # metrics: + # - library.googleapis.com/book/borrowed_count + # Corresponds to the JSON property `billing` + # @return [Google::Apis::ServiceconsumermanagementV1::Billing] + attr_accessor :billing + + # The semantic version of the service configuration. The config version + # affects the interpretation of the service configuration. For example, + # certain features are enabled by default for certain config versions. + # The latest config version is `3`. + # Corresponds to the JSON property `configVersion` + # @return [Fixnum] + attr_accessor :config_version + + # `Context` defines which contexts an API requests. + # Example: + # context: + # rules: + # - selector: "*" + # requested: + # - google.rpc.context.ProjectContext + # - google.rpc.context.OriginContext + # The above specifies that all methods in the API request + # `google.rpc.context.ProjectContext` and + # `google.rpc.context.OriginContext`. + # Available context types are defined in package + # `google.rpc.context`. + # Corresponds to the JSON property `context` + # @return [Google::Apis::ServiceconsumermanagementV1::Context] + attr_accessor :context + + # Selects and configures the service controller used by the service. The + # service controller handles features like abuse, quota, billing, logging, + # monitoring, etc. + # Corresponds to the JSON property `control` + # @return [Google::Apis::ServiceconsumermanagementV1::Control] + attr_accessor :control + + # Customize service error responses. For example, list any service + # specific protobuf types that can appear in error detail lists of + # error responses. + # Example: + # custom_error: + # types: + # - google.foo.v1.CustomError + # - google.foo.v1.AnotherError + # Corresponds to the JSON property `customError` + # @return [Google::Apis::ServiceconsumermanagementV1::CustomError] + attr_accessor :custom_error + + # `Documentation` provides the information for describing a service. + # Example: + # 
documentation:
+        # summary: >
+        # The Google Calendar API gives access
+        # to most calendar features.
+        # pages:
+        # - name: Overview
+        # content: (== include google/foo/overview.md ==)
+        # - name: Tutorial
+        # content: (== include google/foo/tutorial.md ==)
+        # subpages;
+        # - name: Java
+        # content: (== include google/foo/tutorial_java.md ==)
+        # rules:
+        # - selector: google.calendar.Calendar.Get
+        # description: >
+        # ...
+        # - selector: google.calendar.Calendar.Put
+        # description: >
+        # ...
+        #
+ # Documentation is provided in markdown syntax. In addition to + # standard markdown features, definition lists, tables and fenced + # code blocks are supported. Section headers can be provided and are + # interpreted relative to the section nesting of the context where + # a documentation fragment is embedded. + # Documentation from the IDL is merged with documentation defined + # via the config at normalization time, where documentation provided + # by config rules overrides IDL provided. + # A number of constructs specific to the API platform are supported + # in documentation text. + # In order to reference a proto element, the following + # notation can be used: + # 
[fully.qualified.proto.name][]
+ # To override the display text used for the link, this can be used: + # 
[display text][fully.qualified.proto.name]
+ # Text can be excluded from doc using the following notation: + # 
(-- internal comment --)
+ # Comments can be made conditional using a visibility label. The below + # text will be only rendered if the `BETA` label is available: + # 
(--BETA: comment for BETA users --)
+ # A few directives are available in documentation. Note that + # directives must appear on a single line to be properly + # identified. The `include` directive includes a markdown file from + # an external source: + # 
(== include path/to/file ==)
+ # The `resource_for` directive marks a message to be the resource of + # a collection in REST view. If it is not specified, tools attempt + # to infer the resource from the operations in a collection: + # 
(== resource_for v1.shelves.books ==)
+ # The directive `suppress_warning` does not directly affect documentation + # and is documented together with service config validation. + # Corresponds to the JSON property `documentation` + # @return [Google::Apis::ServiceconsumermanagementV1::Documentation] + attr_accessor :documentation + + # Configuration for network endpoints. If this is empty, then an endpoint + # with the same name as the service is automatically generated to service all + # defined APIs. + # Corresponds to the JSON property `endpoints` + # @return [Array] + attr_accessor :endpoints + + # A list of all enum types included in this API service. Enums + # referenced directly or indirectly by the `apis` are automatically + # included. Enums which are not referenced but shall be included + # should be listed here by name. Example: + # enums: + # - name: google.someapi.v1.SomeEnum + # Corresponds to the JSON property `enums` + # @return [Array] + attr_accessor :enums + + # Experimental service configuration. These configuration options can + # only be used by whitelisted users. + # Corresponds to the JSON property `experimental` + # @return [Google::Apis::ServiceconsumermanagementV1::Experimental] + attr_accessor :experimental + + # Defines the HTTP configuration for an API service. It contains a list of + # HttpRule, each specifying the mapping of an RPC method + # to one or more HTTP REST API methods. + # Corresponds to the JSON property `http` + # @return [Google::Apis::ServiceconsumermanagementV1::Http] + attr_accessor :http + + # A unique ID for a specific instance of this message, typically assigned + # by the client for tracking purpose. If empty, the server may choose to + # generate one instead. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Logging configuration of the service. + # The following example shows how to configure logs to be sent to the + # producer and consumer projects. In the example, the `activity_history` + # log is sent to both the producer and consumer projects, whereas the + # `purchase_history` log is only sent to the producer project. + # monitored_resources: + # - type: library.googleapis.com/branch + # labels: + # - key: /city + # description: The city where the library branch is located in. + # - key: /name + # description: The name of the branch. + # logs: + # - name: activity_history + # labels: + # - key: /customer_id + # - name: purchase_history + # logging: + # producer_destinations: + # - monitored_resource: library.googleapis.com/branch + # logs: + # - activity_history + # - purchase_history + # consumer_destinations: + # - monitored_resource: library.googleapis.com/branch + # logs: + # - activity_history + # Corresponds to the JSON property `logging` + # @return [Google::Apis::ServiceconsumermanagementV1::Logging] + attr_accessor :logging + + # Defines the logs used by this service. + # Corresponds to the JSON property `logs` + # @return [Array] + attr_accessor :logs + + # Defines the metrics used by this service. + # Corresponds to the JSON property `metrics` + # @return [Array] + attr_accessor :metrics + + # Defines the monitored resources used by this service. This is required + # by the Service.monitoring and Service.logging configurations. + # Corresponds to the JSON property `monitoredResources` + # @return [Array] + attr_accessor :monitored_resources + + # Monitoring configuration of the service. + # The example below shows how to configure monitored resources and metrics + # for monitoring. In the example, a monitored resource and two metrics are + # defined. The `library.googleapis.com/book/returned_count` metric is sent + # to both producer and consumer projects, whereas the + # `library.googleapis.com/book/overdue_count` metric is only sent to the + # consumer project. + # monitored_resources: + # - type: library.googleapis.com/branch + # labels: + # - key: /city + # description: The city where the library branch is located in. + # - key: /name + # description: The name of the branch. + # metrics: + # - name: library.googleapis.com/book/returned_count + # metric_kind: DELTA + # value_type: INT64 + # labels: + # - key: /customer_id + # - name: library.googleapis.com/book/overdue_count + # metric_kind: GAUGE + # value_type: INT64 + # labels: + # - key: /customer_id + # monitoring: + # producer_destinations: + # - monitored_resource: library.googleapis.com/branch + # metrics: + # - library.googleapis.com/book/returned_count + # consumer_destinations: + # - monitored_resource: library.googleapis.com/branch + # metrics: + # - library.googleapis.com/book/returned_count + # - library.googleapis.com/book/overdue_count + # Corresponds to the JSON property `monitoring` + # @return [Google::Apis::ServiceconsumermanagementV1::Monitoring] + attr_accessor :monitoring + + # The DNS address at which this service is available, + # e.g. `calendar.googleapis.com`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The Google project that owns this service. + # Corresponds to the JSON property `producerProjectId` + # @return [String] + attr_accessor :producer_project_id + + # Quota configuration helps to achieve fairness and budgeting in service + # usage. + # The quota configuration works this way: + # - The service configuration defines a set of metrics. + # - For API calls, the quota.metric_rules maps methods to metrics with + # corresponding costs. + # - The quota.limits defines limits on the metrics, which will be used for + # quota checks at runtime. + # An example quota configuration in yaml format: + # quota: + # - name: apiWriteQpsPerProject + # metric: library.googleapis.com/write_calls + # unit: "1/min/`project`" # rate limit for consumer projects + # values: + # STANDARD: 10000 + # # The metric rules bind all methods to the read_calls metric, + # # except for the UpdateBook and DeleteBook methods. These two methods + # # are mapped to the write_calls metric, with the UpdateBook method + # # consuming at twice rate as the DeleteBook method. + # metric_rules: + # - selector: "*" + # metric_costs: + # library.googleapis.com/read_calls: 1 + # - selector: google.example.library.v1.LibraryService.UpdateBook + # metric_costs: + # library.googleapis.com/write_calls: 2 + # - selector: google.example.library.v1.LibraryService.DeleteBook + # metric_costs: + # library.googleapis.com/write_calls: 1 + # Corresponding Metric definition: + # metrics: + # - name: library.googleapis.com/read_calls + # display_name: Read requests + # metric_kind: DELTA + # value_type: INT64 + # - name: library.googleapis.com/write_calls + # display_name: Write requests + # metric_kind: DELTA + # value_type: INT64 + # Corresponds to the JSON property `quota` + # @return [Google::Apis::ServiceconsumermanagementV1::Quota] + attr_accessor :quota + + # Source information used to create a Service Config + # Corresponds to the JSON property `sourceInfo` + # @return [Google::Apis::ServiceconsumermanagementV1::SourceInfo] + attr_accessor :source_info + + # ### System parameter configuration + # A system parameter is a special kind of parameter defined by the API + # system, not by an individual API. It is typically mapped to an HTTP header + # and/or a URL query parameter. This configuration specifies which methods + # change the names of the system parameters. + # Corresponds to the JSON property `systemParameters` + # @return [Google::Apis::ServiceconsumermanagementV1::SystemParameters] + attr_accessor :system_parameters + + # A list of all proto message types included in this API service. + # It serves similar purpose as [google.api.Service.types], except that + # these types are not needed by user-defined APIs. Therefore, they will not + # show up in the generated discovery doc. This field should only be used + # to define system APIs in ESF. + # Corresponds to the JSON property `systemTypes` + # @return [Array] + attr_accessor :system_types + + # The product title for this service. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # A list of all proto message types included in this API service. + # Types referenced directly or indirectly by the `apis` are + # automatically included. Messages which are not referenced but + # shall be included, such as types used by the `google.protobuf.Any` type, + # should be listed here by name. Example: + # types: + # - name: google.protobuf.Int32 + # Corresponds to the JSON property `types` + # @return [Array] + attr_accessor :types + + # Configuration controlling usage of a service. + # Corresponds to the JSON property `usage` + # @return [Google::Apis::ServiceconsumermanagementV1::Usage] + attr_accessor :usage + + # `Visibility` defines restrictions for the visibility of service + # elements. Restrictions are specified using visibility labels + # (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects. + # Users and projects can have access to more than one visibility label. The + # effective visibility for multiple labels is the union of each label's + # elements, plus any unrestricted elements. + # If an element and its parents have no restrictions, visibility is + # unconditionally granted. + # Example: + # visibility: + # rules: + # - selector: google.calendar.Calendar.EnhancedSearch + # restriction: TRUSTED_TESTER + # - selector: google.calendar.Calendar.Delegate + # restriction: GOOGLE_INTERNAL + # Here, all methods are publicly visible except for the restricted methods + # EnhancedSearch and Delegate. + # Corresponds to the JSON property `visibility` + # @return [Google::Apis::ServiceconsumermanagementV1::Visibility] + attr_accessor :visibility + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @apis = args[:apis] if args.key?(:apis) + @authentication = args[:authentication] if args.key?(:authentication) + @backend = args[:backend] if args.key?(:backend) + @billing = args[:billing] if args.key?(:billing) + @config_version = args[:config_version] if args.key?(:config_version) + @context = args[:context] if args.key?(:context) + @control = args[:control] if args.key?(:control) + @custom_error = args[:custom_error] if args.key?(:custom_error) + @documentation = args[:documentation] if args.key?(:documentation) + @endpoints = args[:endpoints] if args.key?(:endpoints) + @enums = args[:enums] if args.key?(:enums) + @experimental = args[:experimental] if args.key?(:experimental) + @http = args[:http] if args.key?(:http) + @id = args[:id] if args.key?(:id) + @logging = args[:logging] if args.key?(:logging) + @logs = args[:logs] if args.key?(:logs) + @metrics = args[:metrics] if args.key?(:metrics) + @monitored_resources = args[:monitored_resources] if args.key?(:monitored_resources) + @monitoring = args[:monitoring] if args.key?(:monitoring) + @name = args[:name] if args.key?(:name) + @producer_project_id = args[:producer_project_id] if args.key?(:producer_project_id) + @quota = args[:quota] if args.key?(:quota) + @source_info = args[:source_info] if args.key?(:source_info) + @system_parameters = args[:system_parameters] if args.key?(:system_parameters) + @system_types = args[:system_types] if args.key?(:system_types) + @title = args[:title] if args.key?(:title) + @types = args[:types] if args.key?(:types) + @usage = args[:usage] if args.key?(:usage) + @visibility = args[:visibility] if args.key?(:visibility) + end + end + + # Describes service account configuration for the tenant project. + class ServiceAccountConfig + include Google::Apis::Core::Hashable + + # ID of the IAM service account to be created in tenant project. + # The email format of the service account will be + # "@.iam.gserviceaccount.com". + # This account id has to be unique within tenant project and producers + # have to guarantee it. + # Corresponds to the JSON property `accountId` + # @return [String] + attr_accessor :account_id + + # Roles for the service account above on tenant project. + # Corresponds to the JSON property `tenantProjectRoles` + # @return [Array] + attr_accessor :tenant_project_roles + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @tenant_project_roles = args[:tenant_project_roles] if args.key?(:tenant_project_roles) + end + end + + # `SourceContext` represents information about the source of a + # protobuf element, like the file in which it is defined. + class SourceContext + include Google::Apis::Core::Hashable + + # The path-qualified name of the .proto file that contained the associated + # protobuf element. For example: `"google/protobuf/source_context.proto"`. + # Corresponds to the JSON property `fileName` + # @return [String] + attr_accessor :file_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @file_name = args[:file_name] if args.key?(:file_name) + end + end + + # Source information used to create a Service Config + class SourceInfo + include Google::Apis::Core::Hashable + + # All files used during config generation. + # Corresponds to the JSON property `sourceFiles` + # @return [Array>] + attr_accessor :source_files + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @source_files = args[:source_files] if args.key?(:source_files) + end + end + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by + # [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error message, + # and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + class Status + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # A developer-facing error message, which should be in English. Any + # user-facing error message should be localized and sent in the + # google.rpc.Status.details field, or localized by the client. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + + # Define a parameter's name and location. The parameter may be passed as either + # an HTTP header or a URL query parameter, and if both are passed the behavior + # is implementation-dependent. + class SystemParameter + include Google::Apis::Core::Hashable + + # Define the HTTP header name to use for the parameter. It is case + # insensitive. + # Corresponds to the JSON property `httpHeader` + # @return [String] + attr_accessor :http_header + + # Define the name of the parameter, such as "api_key" . It is case sensitive. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Define the URL query parameter name to use for the parameter. It is case + # sensitive. + # Corresponds to the JSON property `urlQueryParameter` + # @return [String] + attr_accessor :url_query_parameter + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @http_header = args[:http_header] if args.key?(:http_header) + @name = args[:name] if args.key?(:name) + @url_query_parameter = args[:url_query_parameter] if args.key?(:url_query_parameter) + end + end + + # Define a system parameter rule mapping system parameter definitions to + # methods. + class SystemParameterRule + include Google::Apis::Core::Hashable + + # Define parameters. Multiple names may be defined for a parameter. + # For a given method call, only one of them should be used. If multiple + # names are used the behavior is implementation-dependent. + # If none of the specified names are present the behavior is + # parameter-dependent. + # Corresponds to the JSON property `parameters` + # @return [Array] + attr_accessor :parameters + + # Selects the methods to which this rule applies. Use '*' to indicate all + # methods in all APIs. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @parameters = args[:parameters] if args.key?(:parameters) + @selector = args[:selector] if args.key?(:selector) + end + end + + # ### System parameter configuration + # A system parameter is a special kind of parameter defined by the API + # system, not by an individual API. It is typically mapped to an HTTP header + # and/or a URL query parameter. This configuration specifies which methods + # change the names of the system parameters. + class SystemParameters + include Google::Apis::Core::Hashable + + # Define system parameters. + # The parameters defined here will override the default parameters + # implemented by the system. If this field is missing from the service + # config, default system parameters will be used. Default system parameters + # and names is implementation-dependent. + # Example: define api key for all methods + # system_parameters + # rules: + # - selector: "*" + # parameters: + # - name: api_key + # url_query_parameter: api_key + # Example: define 2 api key names for a specific method. + # system_parameters + # rules: + # - selector: "/ListShelves" + # parameters: + # - name: api_key + # http_header: Api-Key1 + # - name: api_key + # http_header: Api-Key2 + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @rules = args[:rules] if args.key?(:rules) + end + end + + # Representation of a tenancy unit. + class TenancyUnit + include Google::Apis::Core::Hashable + + # @OutputOnly Cloud resource One Platform Name of the consumer of this + # service. For example 'projects/123456'. + # Corresponds to the JSON property `consumer` + # @return [String] + attr_accessor :consumer + + # @OutputOnly The time this tenancy unit was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Globally unique identifier of this tenancy unit + # "services/`service`/`collection id`/`resource id`/tenancyUnits/`unit`" + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # @OutputOnly Google Cloud API name of the service owning this tenancy unit. + # For example 'serviceconsumermanagement.googleapis.com'. + # Corresponds to the JSON property `service` + # @return [String] + attr_accessor :service + + # Resources constituting the tenancy unit. + # Corresponds to the JSON property `tenantResources` + # @return [Array] + attr_accessor :tenant_resources + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @consumer = args[:consumer] if args.key?(:consumer) + @create_time = args[:create_time] if args.key?(:create_time) + @name = args[:name] if args.key?(:name) + @service = args[:service] if args.key?(:service) + @tenant_resources = args[:tenant_resources] if args.key?(:tenant_resources) + end + end + + # This structure defines a tenant project to be added to the specified tenancy + # unit and its initial configuration and properties. A project lien will be + # created for the tenant project to prevent the tenant project from being + # deleted accidentally. The lien will be deleted as part of tenant project + # removal. + class TenantProjectConfig + include Google::Apis::Core::Hashable + + # Describes billing configuration for new a Tenant Project + # Corresponds to the JSON property `billingConfig` + # @return [Google::Apis::ServiceconsumermanagementV1::BillingConfig] + attr_accessor :billing_config + + # Folder where project in this tenancy unit must be located + # This folder must have been previously created with proper + # permissions for the caller to create and configure a project in it. + # Valid folder resource names have the format `folders/`folder_number`` + # (for example, `folders/123456`). + # Corresponds to the JSON property `folder` + # @return [String] + attr_accessor :folder + + # Labels that will be applied to this project. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # Describes service account configuration for the tenant project. + # Corresponds to the JSON property `serviceAccountConfig` + # @return [Google::Apis::ServiceconsumermanagementV1::ServiceAccountConfig] + attr_accessor :service_account_config + + # Google Cloud API names of services that will be activated on this project + # during provisioning. If any of these services can not be activated, + # addTenantProject method will fail. + # For example: 'compute.googleapis.com','cloudfunctions.googleapis.com' + # Corresponds to the JSON property `services` + # @return [Array] + attr_accessor :services + + # Describes policy settings that need to be applied to a newly + # created Tenant Project. + # Corresponds to the JSON property `tenantProjectPolicy` + # @return [Google::Apis::ServiceconsumermanagementV1::TenantProjectPolicy] + attr_accessor :tenant_project_policy + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @billing_config = args[:billing_config] if args.key?(:billing_config) + @folder = args[:folder] if args.key?(:folder) + @labels = args[:labels] if args.key?(:labels) + @service_account_config = args[:service_account_config] if args.key?(:service_account_config) + @services = args[:services] if args.key?(:services) + @tenant_project_policy = args[:tenant_project_policy] if args.key?(:tenant_project_policy) + end + end + + # Describes policy settings that need to be applied to a newly + # created Tenant Project. + class TenantProjectPolicy + include Google::Apis::Core::Hashable + + # Additional policy bindings to be applied on the tenant + # project. + # At least one owner must be set in the bindings. Among the list of members + # as owners, at least one of them must be either `user` or `group` based. + # Corresponds to the JSON property `policyBindings` + # @return [Array] + attr_accessor :policy_bindings + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @policy_bindings = args[:policy_bindings] if args.key?(:policy_bindings) + end + end + + # Resource constituting the TenancyUnit. + class TenantResource + include Google::Apis::Core::Hashable + + # @OutputOnly Identifier of the tenant resource. + # For cloud projects it is in the form 'projects/`number`'. + # For example 'projects/123456'. + # Corresponds to the JSON property `resource` + # @return [String] + attr_accessor :resource + + # Status of tenant resource. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # Unique per single tenancy unit. + # Corresponds to the JSON property `tag` + # @return [String] + attr_accessor :tag + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource = args[:resource] if args.key?(:resource) + @status = args[:status] if args.key?(:status) + @tag = args[:tag] if args.key?(:tag) + end + end + + # A protocol buffer message type. + class Type + include Google::Apis::Core::Hashable + + # The list of fields. + # Corresponds to the JSON property `fields` + # @return [Array] + attr_accessor :fields + + # The fully qualified message name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The list of types appearing in `oneof` definitions in this type. + # Corresponds to the JSON property `oneofs` + # @return [Array] + attr_accessor :oneofs + + # The protocol buffer options. + # Corresponds to the JSON property `options` + # @return [Array] + attr_accessor :options + + # `SourceContext` represents information about the source of a + # protobuf element, like the file in which it is defined. + # Corresponds to the JSON property `sourceContext` + # @return [Google::Apis::ServiceconsumermanagementV1::SourceContext] + attr_accessor :source_context + + # The source syntax. + # Corresponds to the JSON property `syntax` + # @return [String] + attr_accessor :syntax + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fields = args[:fields] if args.key?(:fields) + @name = args[:name] if args.key?(:name) + @oneofs = args[:oneofs] if args.key?(:oneofs) + @options = args[:options] if args.key?(:options) + @source_context = args[:source_context] if args.key?(:source_context) + @syntax = args[:syntax] if args.key?(:syntax) + end + end + + # Configuration controlling usage of a service. + class Usage + include Google::Apis::Core::Hashable + + # The full resource name of a channel used for sending notifications to the + # service producer. + # Google Service Management currently only supports + # [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification + # channel. To use Google Cloud Pub/Sub as the channel, this must be the name + # of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format + # documented in https://cloud.google.com/pubsub/docs/overview. + # Corresponds to the JSON property `producerNotificationChannel` + # @return [String] + attr_accessor :producer_notification_channel + + # Requirements that must be satisfied before a consumer project can use the + # service. Each requirement is of the form /; + # for example 'serviceusage.googleapis.com/billing-enabled'. + # Corresponds to the JSON property `requirements` + # @return [Array] + attr_accessor :requirements + + # A list of usage rules that apply to individual API methods. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @producer_notification_channel = args[:producer_notification_channel] if args.key?(:producer_notification_channel) + @requirements = args[:requirements] if args.key?(:requirements) + @rules = args[:rules] if args.key?(:rules) + end + end + + # Usage configuration rules for the service. + # NOTE: Under development. + # Use this rule to configure unregistered calls for the service. Unregistered + # calls are calls that do not contain consumer project identity. + # (Example: calls that do not contain an API key). + # By default, API methods do not allow unregistered calls, and each method call + # must be identified by a consumer project identity. Use this rule to + # allow/disallow unregistered calls. + # Example of an API that wants to allow unregistered calls for entire service. + # usage: + # rules: + # - selector: "*" + # allow_unregistered_calls: true + # Example of a method that wants to allow unregistered calls. + # usage: + # rules: + # - selector: "google.example.library.v1.LibraryService.CreateBook" + # allow_unregistered_calls: true + class UsageRule + include Google::Apis::Core::Hashable + + # True, if the method allows unregistered calls; false otherwise. + # Corresponds to the JSON property `allowUnregisteredCalls` + # @return [Boolean] + attr_accessor :allow_unregistered_calls + alias_method :allow_unregistered_calls?, :allow_unregistered_calls + + # Selects the methods to which this rule applies. Use '*' to indicate all + # methods in all APIs. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + # True, if the method should skip service control. If so, no control plane + # feature (like quota and billing) will be enabled. + # This flag is used by ESP to allow some Endpoints customers to bypass + # Google internal checks. + # Corresponds to the JSON property `skipServiceControl` + # @return [Boolean] + attr_accessor :skip_service_control + alias_method :skip_service_control?, :skip_service_control + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allow_unregistered_calls = args[:allow_unregistered_calls] if args.key?(:allow_unregistered_calls) + @selector = args[:selector] if args.key?(:selector) + @skip_service_control = args[:skip_service_control] if args.key?(:skip_service_control) + end + end + + # `Visibility` defines restrictions for the visibility of service + # elements. Restrictions are specified using visibility labels + # (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects. + # Users and projects can have access to more than one visibility label. The + # effective visibility for multiple labels is the union of each label's + # elements, plus any unrestricted elements. + # If an element and its parents have no restrictions, visibility is + # unconditionally granted. + # Example: + # visibility: + # rules: + # - selector: google.calendar.Calendar.EnhancedSearch + # restriction: TRUSTED_TESTER + # - selector: google.calendar.Calendar.Delegate + # restriction: GOOGLE_INTERNAL + # Here, all methods are publicly visible except for the restricted methods + # EnhancedSearch and Delegate. + class Visibility + include Google::Apis::Core::Hashable + + # A list of visibility rules that apply to individual API elements. + # **NOTE:** All service configuration rules follow "last one wins" order. + # Corresponds to the JSON property `rules` + # @return [Array] + attr_accessor :rules + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @rules = args[:rules] if args.key?(:rules) + end + end + + # A visibility rule provides visibility configuration for an individual API + # element. + class VisibilityRule + include Google::Apis::Core::Hashable + + # A comma-separated list of visibility labels that apply to the `selector`. + # Any of the listed labels can be used to grant the visibility. + # If a rule has multiple labels, removing one of the labels but not all of + # them can break clients. + # Example: + # visibility: + # rules: + # - selector: google.calendar.Calendar.EnhancedSearch + # restriction: GOOGLE_INTERNAL, TRUSTED_TESTER + # Removing GOOGLE_INTERNAL from this restriction will break clients that + # rely on this method and only had access to it through GOOGLE_INTERNAL. + # Corresponds to the JSON property `restriction` + # @return [String] + attr_accessor :restriction + + # Selects methods, messages, fields, enums, etc. to which this rule applies. + # Refer to selector for syntax details. + # Corresponds to the JSON property `selector` + # @return [String] + attr_accessor :selector + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @restriction = args[:restriction] if args.key?(:restriction) + @selector = args[:selector] if args.key?(:selector) + end + end + end + end +end diff --git a/generated/google/apis/serviceconsumermanagement_v1/representations.rb b/generated/google/apis/serviceconsumermanagement_v1/representations.rb new file mode 100644 index 000000000..be94c42dc --- /dev/null +++ b/generated/google/apis/serviceconsumermanagement_v1/representations.rb @@ -0,0 +1,1235 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module ServiceconsumermanagementV1 + + class AddTenantProjectRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Api + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuthProvider + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuthRequirement + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Authentication + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuthenticationRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuthorizationConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuthorizationRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Backend + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BackendRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Billing + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BillingConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BillingDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CancelOperationRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Context + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ContextRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Control + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CreateTenancyUnitRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomAuthRequirements + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomError + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomErrorRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomHttpPattern + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Documentation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DocumentationRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Endpoint + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Enum + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EnumValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Experimental + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Field + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Http + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class HttpRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LabelDescriptor + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListTenancyUnitsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LogDescriptor + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Logging + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LoggingDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MediaDownload + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MediaUpload + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MethodProp + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MetricDescriptor + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MetricRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Mixin + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MonitoredResourceDescriptor + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Monitoring + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MonitoringDestination + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OAuthRequirements + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Option + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Page + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PolicyBinding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Quota + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class QuotaLimit + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RemoveTenantProjectRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SearchTenancyUnitsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Service + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ServiceAccountConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SourceContext + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SourceInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SystemParameter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SystemParameterRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SystemParameters + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TenancyUnit + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TenantProjectConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TenantProjectPolicy + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TenantResource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Type + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Usage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UsageRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Visibility + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class VisibilityRule + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AddTenantProjectRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :project_config, as: 'projectConfig', class: Google::Apis::ServiceconsumermanagementV1::TenantProjectConfig, decorator: Google::Apis::ServiceconsumermanagementV1::TenantProjectConfig::Representation + + property :tag, as: 'tag' + end + end + + class Api + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :methods_prop, as: 'methods', class: Google::Apis::ServiceconsumermanagementV1::MethodProp, decorator: Google::Apis::ServiceconsumermanagementV1::MethodProp::Representation + + collection :mixins, as: 'mixins', class: Google::Apis::ServiceconsumermanagementV1::Mixin, decorator: Google::Apis::ServiceconsumermanagementV1::Mixin::Representation + + property :name, as: 'name' + collection :options, as: 'options', class: Google::Apis::ServiceconsumermanagementV1::Option, decorator: Google::Apis::ServiceconsumermanagementV1::Option::Representation + + property :source_context, as: 'sourceContext', class: Google::Apis::ServiceconsumermanagementV1::SourceContext, decorator: Google::Apis::ServiceconsumermanagementV1::SourceContext::Representation + + property :syntax, as: 'syntax' + property :version, as: 'version' + end + end + + class AuthProvider + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :audiences, as: 'audiences' + property :authorization_url, as: 'authorizationUrl' + property :id, as: 'id' + property :issuer, as: 'issuer' + property :jwks_uri, as: 'jwksUri' + end + end + + class AuthRequirement + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :audiences, as: 'audiences' + property :provider_id, as: 'providerId' + end + end + + class Authentication + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :providers, as: 'providers', class: Google::Apis::ServiceconsumermanagementV1::AuthProvider, decorator: Google::Apis::ServiceconsumermanagementV1::AuthProvider::Representation + + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1::AuthenticationRule, decorator: Google::Apis::ServiceconsumermanagementV1::AuthenticationRule::Representation + + end + end + + class AuthenticationRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allow_without_credential, as: 'allowWithoutCredential' + property :custom_auth, as: 'customAuth', class: Google::Apis::ServiceconsumermanagementV1::CustomAuthRequirements, decorator: Google::Apis::ServiceconsumermanagementV1::CustomAuthRequirements::Representation + + property :oauth, as: 'oauth', class: Google::Apis::ServiceconsumermanagementV1::OAuthRequirements, decorator: Google::Apis::ServiceconsumermanagementV1::OAuthRequirements::Representation + + collection :requirements, as: 'requirements', class: Google::Apis::ServiceconsumermanagementV1::AuthRequirement, decorator: Google::Apis::ServiceconsumermanagementV1::AuthRequirement::Representation + + property :selector, as: 'selector' + end + end + + class AuthorizationConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :provider, as: 'provider' + end + end + + class AuthorizationRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :permissions, as: 'permissions' + property :selector, as: 'selector' + end + end + + class Backend + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1::BackendRule, decorator: Google::Apis::ServiceconsumermanagementV1::BackendRule::Representation + + end + end + + class BackendRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :address, as: 'address' + property :deadline, as: 'deadline' + property :min_deadline, as: 'minDeadline' + property :selector, as: 'selector' + end + end + + class Billing + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :consumer_destinations, as: 'consumerDestinations', class: Google::Apis::ServiceconsumermanagementV1::BillingDestination, decorator: Google::Apis::ServiceconsumermanagementV1::BillingDestination::Representation + + end + end + + class BillingConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :billing_account, as: 'billingAccount' + end + end + + class BillingDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :metrics, as: 'metrics' + property :monitored_resource, as: 'monitoredResource' + end + end + + class CancelOperationRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Context + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1::ContextRule, decorator: Google::Apis::ServiceconsumermanagementV1::ContextRule::Representation + + end + end + + class ContextRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :provided, as: 'provided' + collection :requested, as: 'requested' + property :selector, as: 'selector' + end + end + + class Control + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :environment, as: 'environment' + end + end + + class CreateTenancyUnitRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :tenancy_unit_id, as: 'tenancyUnitId' + end + end + + class CustomAuthRequirements + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :provider, as: 'provider' + end + end + + class CustomError + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1::CustomErrorRule, decorator: Google::Apis::ServiceconsumermanagementV1::CustomErrorRule::Representation + + collection :types, as: 'types' + end + end + + class CustomErrorRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :is_error_type, as: 'isErrorType' + property :selector, as: 'selector' + end + end + + class CustomHttpPattern + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :path, as: 'path' + end + end + + class Documentation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :documentation_root_url, as: 'documentationRootUrl' + property :overview, as: 'overview' + collection :pages, as: 'pages', class: Google::Apis::ServiceconsumermanagementV1::Page, decorator: Google::Apis::ServiceconsumermanagementV1::Page::Representation + + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1::DocumentationRule, decorator: Google::Apis::ServiceconsumermanagementV1::DocumentationRule::Representation + + property :summary, as: 'summary' + end + end + + class DocumentationRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :deprecation_description, as: 'deprecationDescription' + property :description, as: 'description' + property :selector, as: 'selector' + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Endpoint + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :aliases, as: 'aliases' + property :allow_cors, as: 'allowCors' + collection :features, as: 'features' + property :name, as: 'name' + property :target, as: 'target' + end + end + + class Enum + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :enumvalue, as: 'enumvalue', class: Google::Apis::ServiceconsumermanagementV1::EnumValue, decorator: Google::Apis::ServiceconsumermanagementV1::EnumValue::Representation + + property :name, as: 'name' + collection :options, as: 'options', class: Google::Apis::ServiceconsumermanagementV1::Option, decorator: Google::Apis::ServiceconsumermanagementV1::Option::Representation + + property :source_context, as: 'sourceContext', class: Google::Apis::ServiceconsumermanagementV1::SourceContext, decorator: Google::Apis::ServiceconsumermanagementV1::SourceContext::Representation + + property :syntax, as: 'syntax' + end + end + + class EnumValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :number, as: 'number' + collection :options, as: 'options', class: Google::Apis::ServiceconsumermanagementV1::Option, decorator: Google::Apis::ServiceconsumermanagementV1::Option::Representation + + end + end + + class Experimental + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :authorization, as: 'authorization', class: Google::Apis::ServiceconsumermanagementV1::AuthorizationConfig, decorator: Google::Apis::ServiceconsumermanagementV1::AuthorizationConfig::Representation + + end + end + + class Field + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :cardinality, as: 'cardinality' + property :default_value, as: 'defaultValue' + property :json_name, as: 'jsonName' + property :kind, as: 'kind' + property :name, as: 'name' + property :number, as: 'number' + property :oneof_index, as: 'oneofIndex' + collection :options, as: 'options', class: Google::Apis::ServiceconsumermanagementV1::Option, decorator: Google::Apis::ServiceconsumermanagementV1::Option::Representation + + property :packed, as: 'packed' + property :type_url, as: 'typeUrl' + end + end + + class Http + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :fully_decode_reserved_expansion, as: 'fullyDecodeReservedExpansion' + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1::HttpRule, decorator: Google::Apis::ServiceconsumermanagementV1::HttpRule::Representation + + end + end + + class HttpRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :additional_bindings, as: 'additionalBindings', class: Google::Apis::ServiceconsumermanagementV1::HttpRule, decorator: Google::Apis::ServiceconsumermanagementV1::HttpRule::Representation + + collection :authorizations, as: 'authorizations', class: Google::Apis::ServiceconsumermanagementV1::AuthorizationRule, decorator: Google::Apis::ServiceconsumermanagementV1::AuthorizationRule::Representation + + property :body, as: 'body' + property :custom, as: 'custom', class: Google::Apis::ServiceconsumermanagementV1::CustomHttpPattern, decorator: Google::Apis::ServiceconsumermanagementV1::CustomHttpPattern::Representation + + property :delete, as: 'delete' + property :get, as: 'get' + property :media_download, as: 'mediaDownload', class: Google::Apis::ServiceconsumermanagementV1::MediaDownload, decorator: Google::Apis::ServiceconsumermanagementV1::MediaDownload::Representation + + property :media_upload, as: 'mediaUpload', class: Google::Apis::ServiceconsumermanagementV1::MediaUpload, decorator: Google::Apis::ServiceconsumermanagementV1::MediaUpload::Representation + + property :patch, as: 'patch' + property :post, as: 'post' + property :put, as: 'put' + property :response_body, as: 'responseBody' + property :rest_collection, as: 'restCollection' + property :rest_method_name, as: 'restMethodName' + property :selector, as: 'selector' + end + end + + class LabelDescriptor + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :key, as: 'key' + property :value_type, as: 'valueType' + end + end + + class ListOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::ServiceconsumermanagementV1::Operation, decorator: Google::Apis::ServiceconsumermanagementV1::Operation::Representation + + end + end + + class ListTenancyUnitsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :tenancy_units, as: 'tenancyUnits', class: Google::Apis::ServiceconsumermanagementV1::TenancyUnit, decorator: Google::Apis::ServiceconsumermanagementV1::TenancyUnit::Representation + + end + end + + class LogDescriptor + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + collection :labels, as: 'labels', class: Google::Apis::ServiceconsumermanagementV1::LabelDescriptor, decorator: Google::Apis::ServiceconsumermanagementV1::LabelDescriptor::Representation + + property :name, as: 'name' + end + end + + class Logging + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :consumer_destinations, as: 'consumerDestinations', class: Google::Apis::ServiceconsumermanagementV1::LoggingDestination, decorator: Google::Apis::ServiceconsumermanagementV1::LoggingDestination::Representation + + collection :producer_destinations, as: 'producerDestinations', class: Google::Apis::ServiceconsumermanagementV1::LoggingDestination, decorator: Google::Apis::ServiceconsumermanagementV1::LoggingDestination::Representation + + end + end + + class LoggingDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :logs, as: 'logs' + property :monitored_resource, as: 'monitoredResource' + end + end + + class MediaDownload + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :complete_notification, as: 'completeNotification' + property :download_service, as: 'downloadService' + property :dropzone, as: 'dropzone' + property :enabled, as: 'enabled' + property :max_direct_download_size, :numeric_string => true, as: 'maxDirectDownloadSize' + property :use_direct_download, as: 'useDirectDownload' + end + end + + class MediaUpload + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :complete_notification, as: 'completeNotification' + property :dropzone, as: 'dropzone' + property :enabled, as: 'enabled' + property :max_size, :numeric_string => true, as: 'maxSize' + collection :mime_types, as: 'mimeTypes' + property :progress_notification, as: 'progressNotification' + property :start_notification, as: 'startNotification' + property :upload_service, as: 'uploadService' + end + end + + class MethodProp + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + collection :options, as: 'options', class: Google::Apis::ServiceconsumermanagementV1::Option, decorator: Google::Apis::ServiceconsumermanagementV1::Option::Representation + + property :request_streaming, as: 'requestStreaming' + property :request_type_url, as: 'requestTypeUrl' + property :response_streaming, as: 'responseStreaming' + property :response_type_url, as: 'responseTypeUrl' + property :syntax, as: 'syntax' + end + end + + class MetricDescriptor + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + collection :labels, as: 'labels', class: Google::Apis::ServiceconsumermanagementV1::LabelDescriptor, decorator: Google::Apis::ServiceconsumermanagementV1::LabelDescriptor::Representation + + property :metric_kind, as: 'metricKind' + property :name, as: 'name' + property :type, as: 'type' + property :unit, as: 'unit' + property :value_type, as: 'valueType' + end + end + + class MetricRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :metric_costs, as: 'metricCosts' + property :selector, as: 'selector' + end + end + + class Mixin + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :root, as: 'root' + end + end + + class MonitoredResourceDescriptor + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + collection :labels, as: 'labels', class: Google::Apis::ServiceconsumermanagementV1::LabelDescriptor, decorator: Google::Apis::ServiceconsumermanagementV1::LabelDescriptor::Representation + + property :name, as: 'name' + property :type, as: 'type' + end + end + + class Monitoring + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :consumer_destinations, as: 'consumerDestinations', class: Google::Apis::ServiceconsumermanagementV1::MonitoringDestination, decorator: Google::Apis::ServiceconsumermanagementV1::MonitoringDestination::Representation + + collection :producer_destinations, as: 'producerDestinations', class: Google::Apis::ServiceconsumermanagementV1::MonitoringDestination, decorator: Google::Apis::ServiceconsumermanagementV1::MonitoringDestination::Representation + + end + end + + class MonitoringDestination + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :metrics, as: 'metrics' + property :monitored_resource, as: 'monitoredResource' + end + end + + class OAuthRequirements + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :canonical_scopes, as: 'canonicalScopes' + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::ServiceconsumermanagementV1::Status, decorator: Google::Apis::ServiceconsumermanagementV1::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class Option + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + hash :value, as: 'value' + end + end + + class Page + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content, as: 'content' + property :name, as: 'name' + collection :subpages, as: 'subpages', class: Google::Apis::ServiceconsumermanagementV1::Page, decorator: Google::Apis::ServiceconsumermanagementV1::Page::Representation + + end + end + + class PolicyBinding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :members, as: 'members' + property :role, as: 'role' + end + end + + class Quota + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :limits, as: 'limits', class: Google::Apis::ServiceconsumermanagementV1::QuotaLimit, decorator: Google::Apis::ServiceconsumermanagementV1::QuotaLimit::Representation + + collection :metric_rules, as: 'metricRules', class: Google::Apis::ServiceconsumermanagementV1::MetricRule, decorator: Google::Apis::ServiceconsumermanagementV1::MetricRule::Representation + + end + end + + class QuotaLimit + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :default_limit, :numeric_string => true, as: 'defaultLimit' + property :description, as: 'description' + property :display_name, as: 'displayName' + property :duration, as: 'duration' + property :free_tier, :numeric_string => true, as: 'freeTier' + property :max_limit, :numeric_string => true, as: 'maxLimit' + property :metric, as: 'metric' + property :name, as: 'name' + property :unit, as: 'unit' + hash :values, as: 'values' + end + end + + class RemoveTenantProjectRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :tag, as: 'tag' + end + end + + class SearchTenancyUnitsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :tenancy_units, as: 'tenancyUnits', class: Google::Apis::ServiceconsumermanagementV1::TenancyUnit, decorator: Google::Apis::ServiceconsumermanagementV1::TenancyUnit::Representation + + end + end + + class Service + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :apis, as: 'apis', class: Google::Apis::ServiceconsumermanagementV1::Api, decorator: Google::Apis::ServiceconsumermanagementV1::Api::Representation + + property :authentication, as: 'authentication', class: Google::Apis::ServiceconsumermanagementV1::Authentication, decorator: Google::Apis::ServiceconsumermanagementV1::Authentication::Representation + + property :backend, as: 'backend', class: Google::Apis::ServiceconsumermanagementV1::Backend, decorator: Google::Apis::ServiceconsumermanagementV1::Backend::Representation + + property :billing, as: 'billing', class: Google::Apis::ServiceconsumermanagementV1::Billing, decorator: Google::Apis::ServiceconsumermanagementV1::Billing::Representation + + property :config_version, as: 'configVersion' + property :context, as: 'context', class: Google::Apis::ServiceconsumermanagementV1::Context, decorator: Google::Apis::ServiceconsumermanagementV1::Context::Representation + + property :control, as: 'control', class: Google::Apis::ServiceconsumermanagementV1::Control, decorator: Google::Apis::ServiceconsumermanagementV1::Control::Representation + + property :custom_error, as: 'customError', class: Google::Apis::ServiceconsumermanagementV1::CustomError, decorator: Google::Apis::ServiceconsumermanagementV1::CustomError::Representation + + property :documentation, as: 'documentation', class: Google::Apis::ServiceconsumermanagementV1::Documentation, decorator: Google::Apis::ServiceconsumermanagementV1::Documentation::Representation + + collection :endpoints, as: 'endpoints', class: Google::Apis::ServiceconsumermanagementV1::Endpoint, decorator: Google::Apis::ServiceconsumermanagementV1::Endpoint::Representation + + collection :enums, as: 'enums', class: Google::Apis::ServiceconsumermanagementV1::Enum, decorator: Google::Apis::ServiceconsumermanagementV1::Enum::Representation + + property :experimental, as: 'experimental', class: Google::Apis::ServiceconsumermanagementV1::Experimental, decorator: Google::Apis::ServiceconsumermanagementV1::Experimental::Representation + + property :http, as: 'http', class: Google::Apis::ServiceconsumermanagementV1::Http, decorator: Google::Apis::ServiceconsumermanagementV1::Http::Representation + + property :id, as: 'id' + property :logging, as: 'logging', class: Google::Apis::ServiceconsumermanagementV1::Logging, decorator: Google::Apis::ServiceconsumermanagementV1::Logging::Representation + + collection :logs, as: 'logs', class: Google::Apis::ServiceconsumermanagementV1::LogDescriptor, decorator: Google::Apis::ServiceconsumermanagementV1::LogDescriptor::Representation + + collection :metrics, as: 'metrics', class: Google::Apis::ServiceconsumermanagementV1::MetricDescriptor, decorator: Google::Apis::ServiceconsumermanagementV1::MetricDescriptor::Representation + + collection :monitored_resources, as: 'monitoredResources', class: Google::Apis::ServiceconsumermanagementV1::MonitoredResourceDescriptor, decorator: Google::Apis::ServiceconsumermanagementV1::MonitoredResourceDescriptor::Representation + + property :monitoring, as: 'monitoring', class: Google::Apis::ServiceconsumermanagementV1::Monitoring, decorator: Google::Apis::ServiceconsumermanagementV1::Monitoring::Representation + + property :name, as: 'name' + property :producer_project_id, as: 'producerProjectId' + property :quota, as: 'quota', class: Google::Apis::ServiceconsumermanagementV1::Quota, decorator: Google::Apis::ServiceconsumermanagementV1::Quota::Representation + + property :source_info, as: 'sourceInfo', class: Google::Apis::ServiceconsumermanagementV1::SourceInfo, decorator: Google::Apis::ServiceconsumermanagementV1::SourceInfo::Representation + + property :system_parameters, as: 'systemParameters', class: Google::Apis::ServiceconsumermanagementV1::SystemParameters, decorator: Google::Apis::ServiceconsumermanagementV1::SystemParameters::Representation + + collection :system_types, as: 'systemTypes', class: Google::Apis::ServiceconsumermanagementV1::Type, decorator: Google::Apis::ServiceconsumermanagementV1::Type::Representation + + property :title, as: 'title' + collection :types, as: 'types', class: Google::Apis::ServiceconsumermanagementV1::Type, decorator: Google::Apis::ServiceconsumermanagementV1::Type::Representation + + property :usage, as: 'usage', class: Google::Apis::ServiceconsumermanagementV1::Usage, decorator: Google::Apis::ServiceconsumermanagementV1::Usage::Representation + + property :visibility, as: 'visibility', class: Google::Apis::ServiceconsumermanagementV1::Visibility, decorator: Google::Apis::ServiceconsumermanagementV1::Visibility::Representation + + end + end + + class ServiceAccountConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, as: 'accountId' + collection :tenant_project_roles, as: 'tenantProjectRoles' + end + end + + class SourceContext + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :file_name, as: 'fileName' + end + end + + class SourceInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :source_files, as: 'sourceFiles' + end + end + + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + + class SystemParameter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :http_header, as: 'httpHeader' + property :name, as: 'name' + property :url_query_parameter, as: 'urlQueryParameter' + end + end + + class SystemParameterRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :parameters, as: 'parameters', class: Google::Apis::ServiceconsumermanagementV1::SystemParameter, decorator: Google::Apis::ServiceconsumermanagementV1::SystemParameter::Representation + + property :selector, as: 'selector' + end + end + + class SystemParameters + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1::SystemParameterRule, decorator: Google::Apis::ServiceconsumermanagementV1::SystemParameterRule::Representation + + end + end + + class TenancyUnit + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :consumer, as: 'consumer' + property :create_time, as: 'createTime' + property :name, as: 'name' + property :service, as: 'service' + collection :tenant_resources, as: 'tenantResources', class: Google::Apis::ServiceconsumermanagementV1::TenantResource, decorator: Google::Apis::ServiceconsumermanagementV1::TenantResource::Representation + + end + end + + class TenantProjectConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :billing_config, as: 'billingConfig', class: Google::Apis::ServiceconsumermanagementV1::BillingConfig, decorator: Google::Apis::ServiceconsumermanagementV1::BillingConfig::Representation + + property :folder, as: 'folder' + hash :labels, as: 'labels' + property :service_account_config, as: 'serviceAccountConfig', class: Google::Apis::ServiceconsumermanagementV1::ServiceAccountConfig, decorator: Google::Apis::ServiceconsumermanagementV1::ServiceAccountConfig::Representation + + collection :services, as: 'services' + property :tenant_project_policy, as: 'tenantProjectPolicy', class: Google::Apis::ServiceconsumermanagementV1::TenantProjectPolicy, decorator: Google::Apis::ServiceconsumermanagementV1::TenantProjectPolicy::Representation + + end + end + + class TenantProjectPolicy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :policy_bindings, as: 'policyBindings', class: Google::Apis::ServiceconsumermanagementV1::PolicyBinding, decorator: Google::Apis::ServiceconsumermanagementV1::PolicyBinding::Representation + + end + end + + class TenantResource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :resource, as: 'resource' + property :status, as: 'status' + property :tag, as: 'tag' + end + end + + class Type + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :fields, as: 'fields', class: Google::Apis::ServiceconsumermanagementV1::Field, decorator: Google::Apis::ServiceconsumermanagementV1::Field::Representation + + property :name, as: 'name' + collection :oneofs, as: 'oneofs' + collection :options, as: 'options', class: Google::Apis::ServiceconsumermanagementV1::Option, decorator: Google::Apis::ServiceconsumermanagementV1::Option::Representation + + property :source_context, as: 'sourceContext', class: Google::Apis::ServiceconsumermanagementV1::SourceContext, decorator: Google::Apis::ServiceconsumermanagementV1::SourceContext::Representation + + property :syntax, as: 'syntax' + end + end + + class Usage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :producer_notification_channel, as: 'producerNotificationChannel' + collection :requirements, as: 'requirements' + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1::UsageRule, decorator: Google::Apis::ServiceconsumermanagementV1::UsageRule::Representation + + end + end + + class UsageRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allow_unregistered_calls, as: 'allowUnregisteredCalls' + property :selector, as: 'selector' + property :skip_service_control, as: 'skipServiceControl' + end + end + + class Visibility + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :rules, as: 'rules', class: Google::Apis::ServiceconsumermanagementV1::VisibilityRule, decorator: Google::Apis::ServiceconsumermanagementV1::VisibilityRule::Representation + + end + end + + class VisibilityRule + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :restriction, as: 'restriction' + property :selector, as: 'selector' + end + end + end + end +end diff --git a/generated/google/apis/serviceconsumermanagement_v1/service.rb b/generated/google/apis/serviceconsumermanagement_v1/service.rb new file mode 100644 index 000000000..b94338898 --- /dev/null +++ b/generated/google/apis/serviceconsumermanagement_v1/service.rb @@ -0,0 +1,467 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module ServiceconsumermanagementV1 + # Service Consumer Management API + # + # Provides management methods for configuring service producer resources on + # Google Cloud. + # + # @example + # require 'google/apis/serviceconsumermanagement_v1' + # + # Serviceconsumermanagement = Google::Apis::ServiceconsumermanagementV1 # Alias the module + # service = Serviceconsumermanagement::ServiceConsumerManagementService.new + # + # @see https://cloud.google.com/service-consumer-management/docs/overview + class ServiceConsumerManagementService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + attr_accessor :quota_user + + def initialize + super('https://serviceconsumermanagement.googleapis.com/', '') + @batch_path = 'batch' + end + + # Starts asynchronous cancellation on a long-running operation. The server + # makes a best effort to cancel the operation, but success is not + # guaranteed. If the server doesn't support this method, it returns + # `google.rpc.Code.UNIMPLEMENTED`. Clients can use + # Operations.GetOperation or + # other methods to check whether the cancellation succeeded or whether the + # operation completed despite cancellation. On successful cancellation, + # the operation is not deleted; instead, it becomes an operation with + # an Operation.error value with a google.rpc.Status.code of 1, + # corresponding to `Code.CANCELLED`. + # @param [String] name + # The name of the operation resource to be cancelled. + # @param [Google::Apis::ServiceconsumermanagementV1::CancelOperationRequest] cancel_operation_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:cancel', options) + command.request_representation = Google::Apis::ServiceconsumermanagementV1::CancelOperationRequest::Representation + command.request_object = cancel_operation_request_object + command.response_representation = Google::Apis::ServiceconsumermanagementV1::Empty::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a long-running operation. This method indicates that the client is + # no longer interested in the operation result. It does not cancel the + # operation. If the server doesn't support this method, it returns + # `google.rpc.Code.UNIMPLEMENTED`. + # @param [String] name + # The name of the operation resource to be deleted. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ServiceconsumermanagementV1::Empty::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of a long-running operation. Clients can use this + # method to poll the operation result at intervals as recommended by the API + # service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ServiceconsumermanagementV1::Operation::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists operations that match the specified filter in the request. If the + # server doesn't support this method, it returns `UNIMPLEMENTED`. + # NOTE: the `name` binding allows API services to override the binding + # to use different resource name schemes, such as `users/*/operations`. To + # override the binding, API services can add a binding such as + # `"/v1/`name=users/*`/operations"` to their service configuration. + # For backwards compatibility, the default name includes the operations + # collection id, however overriding users must ensure the name binding + # is the parent resource, without the operations collection id. + # @param [String] name + # The name of the operation's parent resource. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1::ListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1::ListOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::ServiceconsumermanagementV1::ListOperationsResponse::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1::ListOperationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Search tenancy units for a service. + # @param [String] parent + # Service for which search is performed. + # services/`service` + # `service` the name of a service, for example 'service.googleapis.com'. + # @param [Fixnum] page_size + # The maximum number of results returned by this request. Currently, the + # default maximum is set to 1000. If page_size is not provided or provided a + # number larger than 1000, it will be automatically set to 1000. + # Optional. + # @param [String] page_token + # The continuation token, which is used to page through large result sets. + # To get the next page of results, set this parameter to the value of + # `nextPageToken` from the previous response. + # Optional. + # @param [String] query + # Set a query ``expression`` for querying tenancy units. Your ``expression`` + # must be in the format: `field_name=literal_string`. The `field_name` is the + # name of the field you want to compare. Supported fields are + # `tenant_resources.tag` and`tenant_resources.resource`. + # For example, to search tenancy units that contain at least one tenant + # resource with given tag 'xyz', use query `tenant_resources.tag=xyz`. + # To search tenancy units that contain at least one tenant resource with + # given resource name 'projects/123456', use query + # `tenant_resources.resource=projects/123456`. + # Multiple expressions can be joined with `AND`s. Tenancy units must match + # all expressions to be included in the result set. For example, + # `tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456` + # Optional. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1::SearchTenancyUnitsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1::SearchTenancyUnitsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_services(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}:search', options) + command.response_representation = Google::Apis::ServiceconsumermanagementV1::SearchTenancyUnitsResponse::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1::SearchTenancyUnitsResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['query'] = query unless query.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Add a new tenant project to the tenancy unit. + # If there are previously failed AddTenantProject calls, you might need to + # call RemoveTenantProject first to clean them before you can make another + # AddTenantProject with the same tag. + # Operation. + # @param [String] parent + # Name of the tenancy unit. + # @param [Google::Apis::ServiceconsumermanagementV1::AddTenantProjectRequest] add_tenant_project_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def add_service_tenancy_unit_project(parent, add_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}:addProject', options) + command.request_representation = Google::Apis::ServiceconsumermanagementV1::AddTenantProjectRequest::Representation + command.request_object = add_tenant_project_request_object + command.response_representation = Google::Apis::ServiceconsumermanagementV1::Operation::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a tenancy unit with no tenant resources. + # @param [String] parent + # services/`service`/`collection id`/`resource id` + # `collection id` is the cloud resource collection type representing the + # service consumer, for example 'projects', or 'organizations'. + # `resource id` is the consumer numeric id, such as project number: '123456'. + # `service` the name of a service, for example 'service.googleapis.com'. + # Enabled service binding using the new tenancy unit. + # @param [Google::Apis::ServiceconsumermanagementV1::CreateTenancyUnitRequest] create_tenancy_unit_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1::TenancyUnit] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1::TenancyUnit] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_tenancy_unit(parent, create_tenancy_unit_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/tenancyUnits', options) + command.request_representation = Google::Apis::ServiceconsumermanagementV1::CreateTenancyUnitRequest::Representation + command.request_object = create_tenancy_unit_request_object + command.response_representation = Google::Apis::ServiceconsumermanagementV1::TenancyUnit::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1::TenancyUnit + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Delete tenancy unit. Before the tenancy unit is deleted, there should be + # no tenant resource in it. + # Operation. + # @param [String] name + # Name of the tenancy unit to be deleted. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_service_tenancy_unit(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::ServiceconsumermanagementV1::Operation::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Find tenancy unit for a service and consumer. + # This method should not be used in producers' runtime path, e.g. finding + # the tenant project number when creating VMs. Producers should persist + # the tenant project information after the project is created. + # @param [String] parent + # Service and consumer. Required. + # services/`service`/`collection id`/`resource id` + # `collection id` is the cloud resource collection type representing the + # service consumer, for example 'projects', or 'organizations'. + # `resource id` is the consumer numeric id, such as project number: '123456'. + # `service` the name of a service, for example 'service.googleapis.com'. + # @param [String] filter + # Filter expression over tenancy resources field. Optional. + # @param [Fixnum] page_size + # The maximum number of results returned by this request. + # @param [String] page_token + # The continuation token, which is used to page through large result sets. + # To get the next page of results, set this parameter to the value of + # `nextPageToken` from the previous response. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1::ListTenancyUnitsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1::ListTenancyUnitsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_service_tenancy_units(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/tenancyUnits', options) + command.response_representation = Google::Apis::ServiceconsumermanagementV1::ListTenancyUnitsResponse::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1::ListTenancyUnitsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Removes specified project resource identified by tenant resource tag. + # It will remove project lien with 'TenantManager' origin if that was added. + # It will then attempt to delete the project. + # If that operation fails, this method fails. + # Operation. + # @param [String] name + # Name of the tenancy unit. + # Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'. + # @param [Google::Apis::ServiceconsumermanagementV1::RemoveTenantProjectRequest] remove_tenant_project_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::ServiceconsumermanagementV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::ServiceconsumermanagementV1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def remove_service_tenancy_unit_project(name, remove_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:removeProject', options) + command.request_representation = Google::Apis::ServiceconsumermanagementV1::RemoveTenantProjectRequest::Representation + command.request_object = remove_tenant_project_request_object + command.response_representation = Google::Apis::ServiceconsumermanagementV1::Operation::Representation + command.response_class = Google::Apis::ServiceconsumermanagementV1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/servicecontrol_v1.rb b/generated/google/apis/servicecontrol_v1.rb index fec3808e4..30cd8f4f2 100644 --- a/generated/google/apis/servicecontrol_v1.rb +++ b/generated/google/apis/servicecontrol_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-control/ module ServicecontrolV1 VERSION = 'V1' - REVISION = '20170930' + REVISION = '20171007' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicecontrol_v1/classes.rb b/generated/google/apis/servicecontrol_v1/classes.rb index 5dbdfff54..055899f70 100644 --- a/generated/google/apis/servicecontrol_v1/classes.rb +++ b/generated/google/apis/servicecontrol_v1/classes.rb @@ -1231,8 +1231,10 @@ module Google # Fully qualified name of the API method for which this quota operation is # requested. This name is used for matching quota rules or metric rules and - # billing status rules defined in service configuration. This field is not - # required if the quota operation is performed on non-API resources. + # billing status rules defined in service configuration. + # This field should not be set if any of the following is true: + # (1) the quota operation is performed on non-API resources. + # (2) quota_metrics is set because the caller is doing quota override. # Example of an RPC method name: # google.example.library.v1.LibraryService.CreateShelf # Corresponds to the JSON property `methodName` @@ -1259,6 +1261,7 @@ module Google # label value combinations. If a request has such duplicated MetricValue # instances, the entire request is rejected with # an invalid argument error. + # This field is mutually exclusive with method_name. # Corresponds to the JSON property `quotaMetrics` # @return [Array] attr_accessor :quota_metrics diff --git a/generated/google/apis/servicemanagement_v1.rb b/generated/google/apis/servicemanagement_v1.rb index cf57513b6..58171d747 100644 --- a/generated/google/apis/servicemanagement_v1.rb +++ b/generated/google/apis/servicemanagement_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-management/ module ServicemanagementV1 VERSION = 'V1' - REVISION = '20170929' + REVISION = '20171108' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicemanagement_v1/classes.rb b/generated/google/apis/servicemanagement_v1/classes.rb index d1bf8d56e..1d1e6d1ae 100644 --- a/generated/google/apis/servicemanagement_v1/classes.rb +++ b/generated/google/apis/servicemanagement_v1/classes.rb @@ -1289,8 +1289,8 @@ module Google include Google::Apis::Core::Hashable # DEPRECATED: This field is no longer supported. Instead of using aliases, - # please specify multiple google.api.Endpoint for each of the intented - # alias. + # please specify multiple google.api.Endpoint for each of the intended + # aliases. # Additional names that this endpoint will be hosted on. # Corresponds to the JSON property `aliases` # @return [Array] @@ -1307,13 +1307,6 @@ module Google attr_accessor :allow_cors alias_method :allow_cors?, :allow_cors - # The list of APIs served by this endpoint. - # If no APIs are specified this translates to "all APIs" exported by the - # service, as defined in the top-level service configuration. - # Corresponds to the JSON property `apis` - # @return [Array] - attr_accessor :apis - # The list of features enabled on this endpoint. # Corresponds to the JSON property `features` # @return [Array] @@ -1341,7 +1334,6 @@ module Google def update!(**args) @aliases = args[:aliases] if args.key?(:aliases) @allow_cors = args[:allow_cors] if args.key?(:allow_cors) - @apis = args[:apis] if args.key?(:apis) @features = args[:features] if args.key?(:features) @name = args[:name] if args.key?(:name) @target = args[:target] if args.key?(:target) @@ -2533,6 +2525,8 @@ module Google # A concise name for the metric, which can be displayed in user interfaces. # Use sentence case without an ending period, for example "Request count". + # This field is optional but it is recommended to be set for any metrics + # associated with user-visible concepts, such as Quota. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -2553,14 +2547,7 @@ module Google # @return [String] attr_accessor :metric_kind - # The resource name of the metric descriptor. Depending on the - # implementation, the name typically includes: (1) the parent resource name - # that defines the scope of the metric type or of its data; and (2) the - # metric's URL-encoded type, which also appears in the `type` field of this - # descriptor. For example, following is the resource name of a custom - # metric within the GCP project `my-project-id`: - # "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice% - # 2Fpaid%2Famount" + # The resource name of the metric descriptor. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3387,22 +3374,14 @@ module Google # The name of the metric this quota limit applies to. The quota limits with # the same metric will be checked together during runtime. The metric must be # defined within the service config. - # Used by metric-based quotas only. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # Name of the quota limit. The name is used to refer to the limit when - # overriding the default limit on per-consumer basis. - # For metric-based quota limits, the name must be provided, and it must be - # unique within the service. The name can only include alphanumeric - # characters as well as '-'. + # Name of the quota limit. + # The name must be provided, and it must be unique within the service. The + # name can only include alphanumeric characters as well as '-'. # The maximum length of the limit name is 64 characters. - # The name of a limit is used as a unique identifier for this limit. - # Therefore, once a limit has been put into use, its name should be - # immutable. You can use the display_name field to provide a user-friendly - # name for the limit. The display name can be evolved over time without - # affecting the identity of the limit. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3410,24 +3389,17 @@ module Google # Specify the unit of the quota limit. It uses the same syntax as # Metric.unit. The supported unit kinds are determined by the quota # backend system. - # The [Google Service Control](https://cloud.google.com/service-control) - # supports the following unit components: - # * One of the time intevals: - # * "/min" for quota every minute. - # * "/d" for quota every 24 hours, starting 00:00 US Pacific Time. - # * Otherwise the quota won't be reset by time, such as storage limit. - # * One and only one of the granted containers: - # * "/`project`" quota for a project # Here are some examples: # * "1/min/`project`" for quota per minute per project. # Note: the order of unit components is insignificant. # The "1" at the beginning is required to follow the metric unit syntax. - # Used by metric-based quotas only. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit - # Tiered limit values, currently only STANDARD is supported. + # Tiered limit values. You must specify this as a key:value pair, with an + # integer value that is the maximum number of requests allowed for the + # specified unit. Currently only STANDARD is supported. # Corresponds to the JSON property `values` # @return [Hash] attr_accessor :values @@ -4604,6 +4576,8 @@ module Google # True, if the method should skip service control. If so, no control plane # feature (like quota and billing) will be enabled. + # This flag is used by ESP to allow some Endpoints customers to bypass + # Google internal checks. # Corresponds to the JSON property `skipServiceControl` # @return [Boolean] attr_accessor :skip_service_control diff --git a/generated/google/apis/servicemanagement_v1/representations.rb b/generated/google/apis/servicemanagement_v1/representations.rb index ccb1a066a..41f3b5f68 100644 --- a/generated/google/apis/servicemanagement_v1/representations.rb +++ b/generated/google/apis/servicemanagement_v1/representations.rb @@ -861,7 +861,6 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :aliases, as: 'aliases' property :allow_cors, as: 'allowCors' - collection :apis, as: 'apis' collection :features, as: 'features' property :name, as: 'name' property :target, as: 'target' diff --git a/generated/google/apis/serviceuser_v1.rb b/generated/google/apis/serviceuser_v1.rb index 99b0ced82..316300339 100644 --- a/generated/google/apis/serviceuser_v1.rb +++ b/generated/google/apis/serviceuser_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-management/ module ServiceuserV1 VERSION = 'V1' - REVISION = '20170929' + REVISION = '20171108' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/serviceuser_v1/classes.rb b/generated/google/apis/serviceuser_v1/classes.rb index 5be5b2883..a64f67cf6 100644 --- a/generated/google/apis/serviceuser_v1/classes.rb +++ b/generated/google/apis/serviceuser_v1/classes.rb @@ -863,8 +863,8 @@ module Google include Google::Apis::Core::Hashable # DEPRECATED: This field is no longer supported. Instead of using aliases, - # please specify multiple google.api.Endpoint for each of the intented - # alias. + # please specify multiple google.api.Endpoint for each of the intended + # aliases. # Additional names that this endpoint will be hosted on. # Corresponds to the JSON property `aliases` # @return [Array] @@ -881,13 +881,6 @@ module Google attr_accessor :allow_cors alias_method :allow_cors?, :allow_cors - # The list of APIs served by this endpoint. - # If no APIs are specified this translates to "all APIs" exported by the - # service, as defined in the top-level service configuration. - # Corresponds to the JSON property `apis` - # @return [Array] - attr_accessor :apis - # The list of features enabled on this endpoint. # Corresponds to the JSON property `features` # @return [Array] @@ -915,7 +908,6 @@ module Google def update!(**args) @aliases = args[:aliases] if args.key?(:aliases) @allow_cors = args[:allow_cors] if args.key?(:allow_cors) - @apis = args[:apis] if args.key?(:apis) @features = args[:features] if args.key?(:features) @name = args[:name] if args.key?(:name) @target = args[:target] if args.key?(:target) @@ -1808,6 +1800,8 @@ module Google # A concise name for the metric, which can be displayed in user interfaces. # Use sentence case without an ending period, for example "Request count". + # This field is optional but it is recommended to be set for any metrics + # associated with user-visible concepts, such as Quota. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -1828,14 +1822,7 @@ module Google # @return [String] attr_accessor :metric_kind - # The resource name of the metric descriptor. Depending on the - # implementation, the name typically includes: (1) the parent resource name - # that defines the scope of the metric type or of its data; and (2) the - # metric's URL-encoded type, which also appears in the `type` field of this - # descriptor. For example, following is the resource name of a custom - # metric within the GCP project `my-project-id`: - # "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice% - # 2Fpaid%2Famount" + # The resource name of the metric descriptor. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2631,22 +2618,14 @@ module Google # The name of the metric this quota limit applies to. The quota limits with # the same metric will be checked together during runtime. The metric must be # defined within the service config. - # Used by metric-based quotas only. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric - # Name of the quota limit. The name is used to refer to the limit when - # overriding the default limit on per-consumer basis. - # For metric-based quota limits, the name must be provided, and it must be - # unique within the service. The name can only include alphanumeric - # characters as well as '-'. + # Name of the quota limit. + # The name must be provided, and it must be unique within the service. The + # name can only include alphanumeric characters as well as '-'. # The maximum length of the limit name is 64 characters. - # The name of a limit is used as a unique identifier for this limit. - # Therefore, once a limit has been put into use, its name should be - # immutable. You can use the display_name field to provide a user-friendly - # name for the limit. The display name can be evolved over time without - # affecting the identity of the limit. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2654,24 +2633,17 @@ module Google # Specify the unit of the quota limit. It uses the same syntax as # Metric.unit. The supported unit kinds are determined by the quota # backend system. - # The [Google Service Control](https://cloud.google.com/service-control) - # supports the following unit components: - # * One of the time intevals: - # * "/min" for quota every minute. - # * "/d" for quota every 24 hours, starting 00:00 US Pacific Time. - # * Otherwise the quota won't be reset by time, such as storage limit. - # * One and only one of the granted containers: - # * "/`project`" quota for a project # Here are some examples: # * "1/min/`project`" for quota per minute per project. # Note: the order of unit components is insignificant. # The "1" at the beginning is required to follow the metric unit syntax. - # Used by metric-based quotas only. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit - # Tiered limit values, currently only STANDARD is supported. + # Tiered limit values. You must specify this as a key:value pair, with an + # integer value that is the maximum number of requests allowed for the + # specified unit. Currently only STANDARD is supported. # Corresponds to the JSON property `values` # @return [Hash] attr_accessor :values @@ -3553,6 +3525,8 @@ module Google # True, if the method should skip service control. If so, no control plane # feature (like quota and billing) will be enabled. + # This flag is used by ESP to allow some Endpoints customers to bypass + # Google internal checks. # Corresponds to the JSON property `skipServiceControl` # @return [Boolean] attr_accessor :skip_service_control diff --git a/generated/google/apis/serviceuser_v1/representations.rb b/generated/google/apis/serviceuser_v1/representations.rb index 6ba26b7f0..4919bdd6e 100644 --- a/generated/google/apis/serviceuser_v1/representations.rb +++ b/generated/google/apis/serviceuser_v1/representations.rb @@ -602,7 +602,6 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :aliases, as: 'aliases' property :allow_cors, as: 'allowCors' - collection :apis, as: 'apis' collection :features, as: 'features' property :name, as: 'name' property :target, as: 'target' diff --git a/generated/google/apis/sheets_v4.rb b/generated/google/apis/sheets_v4.rb index 007c5801b..42b85a8e0 100644 --- a/generated/google/apis/sheets_v4.rb +++ b/generated/google/apis/sheets_v4.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/sheets/ module SheetsV4 VERSION = 'V4' - REVISION = '20170929' + REVISION = '20171012' # View and manage the files in your Google Drive AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/sheets_v4/classes.rb b/generated/google/apis/sheets_v4/classes.rb index 03b52adf7..9f74f4ae3 100644 --- a/generated/google/apis/sheets_v4/classes.rb +++ b/generated/google/apis/sheets_v4/classes.rb @@ -6012,8 +6012,7 @@ module Google # @return [String] attr_accessor :formula - # A name to use for the value. This is only used if formula was set. - # Otherwise, the column name is used. + # A name to use for the value. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name diff --git a/generated/google/apis/slides_v1.rb b/generated/google/apis/slides_v1.rb index 39518ef48..70b7f37da 100644 --- a/generated/google/apis/slides_v1.rb +++ b/generated/google/apis/slides_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/slides/ module SlidesV1 VERSION = 'V1' - REVISION = '20171003' + REVISION = '20171113' # View and manage the files in your Google Drive AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/slides_v1/classes.rb b/generated/google/apis/slides_v1/classes.rb index f47ccad4b..5c541a28e 100644 --- a/generated/google/apis/slides_v1/classes.rb +++ b/generated/google/apis/slides_v1/classes.rb @@ -314,7 +314,7 @@ module Google # display inside the presentation. Images must be less than 50MB in size, # cannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF # format. - # The provided URL can be at maximum 2K bytes large. + # The provided URL can be at most 2 kB in length. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -1870,9 +1870,9 @@ module Google attr_accessor :outline_fill # The outline property state. - # Updating the the outline on a page element will implicitly update this - # field to`RENDERED`, unless another value is specified in the same request. - # To have no outline on a page element, set this field to `NOT_RENDERED`. In + # Updating the outline on a page element will implicitly update this field + # to `RENDERED`, unless another value is specified in the same request. To + # have no outline on a page element, set this field to `NOT_RENDERED`. In # this case, any other outline fields set in the same request will be # ignored. # Corresponds to the JSON property `propertyState` @@ -2567,7 +2567,7 @@ module Google # display inside the presentation. Images must be less than 50MB in size, # cannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF # format. - # The provided URL can be at maximum 2K bytes large. + # The provided URL can be at most 2 kB in length. # Corresponds to the JSON property `imageUrl` # @return [String] attr_accessor :image_url @@ -3161,9 +3161,9 @@ module Google attr_accessor :color # The shadow property state. - # Updating the the shadow on a page element will implicitly update this field - # to `RENDERED`, unless another value is specified in the same request. To - # have no shadow on a page element, set this field to `NOT_RENDERED`. In this + # Updating the shadow on a page element will implicitly update this field to + # `RENDERED`, unless another value is specified in the same request. To have + # no shadow on a page element, set this field to `NOT_RENDERED`. In this # case, any other shadow fields set in the same request will be ignored. # Corresponds to the JSON property `propertyState` # @return [String] @@ -3259,7 +3259,7 @@ module Google include Google::Apis::Core::Hashable # The background fill property state. - # Updating the the fill on a shape will implicitly update this field to + # Updating the fill on a shape will implicitly update this field to # `RENDERED`, unless another value is specified in the same request. To # have no fill on a shape, set this field to `NOT_RENDERED`. In this case, # any other fill fields set in the same request will be ignored. @@ -3295,6 +3295,14 @@ module Google class ShapeProperties include Google::Apis::Core::Hashable + # The alignment of the content in the shape. If unspecified, + # the alignment is inherited from a parent placeholder if it exists. If the + # shape has no parent, the default alignment matches the alignment for new + # shapes created in the Slides editor. + # Corresponds to the JSON property `contentAlignment` + # @return [String] + attr_accessor :content_alignment + # A hypertext link. # Corresponds to the JSON property `link` # @return [Google::Apis::SlidesV1::Link] @@ -3329,6 +3337,7 @@ module Google # Update properties of this object def update!(**args) + @content_alignment = args[:content_alignment] if args.key?(:content_alignment) @link = args[:link] if args.key?(:link) @outline = args[:outline] if args.key?(:outline) @shadow = args[:shadow] if args.key?(:shadow) @@ -3501,7 +3510,7 @@ module Google # display inside the presentation. Pictures must be less than 50MB in size, # cannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF # format. - # The provided URL can be at maximum 2K bytes large. + # The provided URL can be at most 2 kB in length. # Corresponds to the JSON property `contentUrl` # @return [String] attr_accessor :content_url @@ -3760,7 +3769,7 @@ module Google include Google::Apis::Core::Hashable # The background fill property state. - # Updating the the fill on a table cell will implicitly update this field + # Updating the fill on a table cell will implicitly update this field # to `RENDERED`, unless another value is specified in the same request. To # have no fill on a table cell, set this field to `NOT_RENDERED`. In this # case, any other fill fields set in the same request will be ignored. @@ -3816,6 +3825,12 @@ module Google class TableCellProperties include Google::Apis::Core::Hashable + # The alignment of the content in the table cell. The default alignment + # matches the alignment for newly created table cells in the Slides editor. + # Corresponds to the JSON property `contentAlignment` + # @return [String] + attr_accessor :content_alignment + # The table cell background fill. # Corresponds to the JSON property `tableCellBackgroundFill` # @return [Google::Apis::SlidesV1::TableCellBackgroundFill] @@ -3827,6 +3842,7 @@ module Google # Update properties of this object def update!(**args) + @content_alignment = args[:content_alignment] if args.key?(:content_alignment) @table_cell_background_fill = args[:table_cell_background_fill] if args.key?(:table_cell_background_fill) end end diff --git a/generated/google/apis/slides_v1/representations.rb b/generated/google/apis/slides_v1/representations.rb index cf3e68b9c..00645a64d 100644 --- a/generated/google/apis/slides_v1/representations.rb +++ b/generated/google/apis/slides_v1/representations.rb @@ -1680,6 +1680,7 @@ module Google class ShapeProperties # @private class Representation < Google::Apis::Core::JsonRepresentation + property :content_alignment, as: 'contentAlignment' property :link, as: 'link', class: Google::Apis::SlidesV1::Link, decorator: Google::Apis::SlidesV1::Link::Representation property :outline, as: 'outline', class: Google::Apis::SlidesV1::Outline, decorator: Google::Apis::SlidesV1::Outline::Representation @@ -1843,6 +1844,7 @@ module Google class TableCellProperties # @private class Representation < Google::Apis::Core::JsonRepresentation + property :content_alignment, as: 'contentAlignment' property :table_cell_background_fill, as: 'tableCellBackgroundFill', class: Google::Apis::SlidesV1::TableCellBackgroundFill, decorator: Google::Apis::SlidesV1::TableCellBackgroundFill::Representation end diff --git a/generated/google/apis/sourcerepo_v1.rb b/generated/google/apis/sourcerepo_v1.rb index 0730c4e7f..c74d8c25f 100644 --- a/generated/google/apis/sourcerepo_v1.rb +++ b/generated/google/apis/sourcerepo_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/source-repositories/docs/apis module SourcerepoV1 VERSION = 'V1' - REVISION = '20170908' + REVISION = '20171110' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/sourcerepo_v1/classes.rb b/generated/google/apis/sourcerepo_v1/classes.rb index e50ab92bb..dd83261d1 100644 --- a/generated/google/apis/sourcerepo_v1/classes.rb +++ b/generated/google/apis/sourcerepo_v1/classes.rb @@ -305,7 +305,7 @@ module Google attr_accessor :url # ID of the webhook listening to updates to trigger mirroring. - # Removing this webook from the other hosting service will stop + # Removing this webhook from the other hosting service will stop # Google Cloud Source Repositories from receiving notifications, # and thereby disabling mirroring. # Corresponds to the JSON property `webhookId` @@ -420,13 +420,14 @@ module Google # @return [String] attr_accessor :name - # The disk usage of the repo, in bytes. - # Only returned by GetRepo. + # The disk usage of the repo, in bytes. Read-only field. Size is only + # returned by GetRepo. # Corresponds to the JSON property `size` # @return [Fixnum] attr_accessor :size # URL to clone the repository from Google Cloud Source Repositories. + # Read-only field. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url diff --git a/generated/google/apis/spanner_v1.rb b/generated/google/apis/spanner_v1.rb index 5fa923a2a..341ded795 100644 --- a/generated/google/apis/spanner_v1.rb +++ b/generated/google/apis/spanner_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/spanner/ module SpannerV1 VERSION = 'V1' - REVISION = '20170914' + REVISION = '20171026' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/spanner_v1/classes.rb b/generated/google/apis/spanner_v1/classes.rb index 106c27c81..8c853b4cf 100644 --- a/generated/google/apis/spanner_v1/classes.rb +++ b/generated/google/apis/spanner_v1/classes.rb @@ -919,17 +919,9 @@ module Google # Required. The number of nodes allocated to this instance. This may be zero # in API responses for instances that are not yet in state `READY`. - # Each Spanner node can provide up to 10,000 QPS of reads or 2000 QPS of - # writes (writing single rows at 1KB data per row), and 2 TiB storage. - # For optimal performance, we recommend provisioning enough nodes to keep - # overall CPU utilization under 75%. - # A minimum of 3 nodes is recommended for production environments. This - # minimum is required for SLAs to apply to your instance. - # Note that Cloud Spanner performance is highly dependent on workload, schema - # design, and dataset characteristics. The performance numbers above are - # estimates, and assume [best practices](https://cloud.google.com/spanner/docs/ - # bulk-loading) - # are followed. + # See [the documentation](https://cloud.google.com/spanner/docs/instances# + # node_count) + # for more information about nodes. # Corresponds to the JSON property `nodeCount` # @return [Fixnum] attr_accessor :node_count @@ -1711,6 +1703,8 @@ module Google # read, or data that is fresh enough to observe the effects of some # previously committed transaction whose timestamp is known. # Note that this option can only be used in single-use transactions. + # A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. + # Example: `"2014-10-02T15:01:23.045123456Z"`. # Corresponds to the JSON property `minReadTimestamp` # @return [String] attr_accessor :min_read_timestamp @@ -1723,6 +1717,8 @@ module Google # Useful for large scale consistent reads such as mapreduces, or # for coordinating many reads against a consistent snapshot of the # data. + # A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. + # Example: `"2014-10-02T15:01:23.045123456Z"`. # Corresponds to the JSON property `readTimestamp` # @return [String] attr_accessor :read_timestamp @@ -1786,7 +1782,6 @@ module Google # If greater than zero, only the first `limit` rows are yielded. If `limit` # is zero, the default is no limit. - # A limit cannot be specified if partition_token is set. # Corresponds to the JSON property `limit` # @return [Fixnum] attr_accessor :limit @@ -1979,12 +1974,14 @@ module Google # the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. # * Label values must be between 0 and 63 characters long and must conform # to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. - # * No more than 20 labels can be associated with a given session. + # * No more than 64 labels can be associated with a given session. + # See https://goo.gl/xmQnxf for more information on and examples of labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The name of the session. + # The name of the session. This is always system-assigned; values provided + # when creating a session are ignored. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2232,6 +2229,8 @@ module Google # For snapshot read-only transactions, the read timestamp chosen # for the transaction. Not returned by default: see # TransactionOptions.ReadOnly.return_read_timestamp. + # A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. + # Example: `"2014-10-02T15:01:23.045123456Z"`. # Corresponds to the JSON property `readTimestamp` # @return [String] attr_accessor :read_timestamp diff --git a/generated/google/apis/spanner_v1/service.rb b/generated/google/apis/spanner_v1/service.rb index 024a941bd..1860e50b4 100644 --- a/generated/google/apis/spanner_v1/service.rb +++ b/generated/google/apis/spanner_v1/service.rb @@ -294,18 +294,18 @@ module Google # @param [String] filter # An expression for filtering the results of the request. Filter rules are # case insensitive. The fields eligible for filtering are: - # * name - # * display_name - # * labels.key where key is the name of a label + # * `name` + # * `display_name` + # * `labels.key` where key is the name of a label # Some examples of using filters are: - # * name:* --> The instance has a name. - # * name:Howl --> The instance's name contains the string "howl". - # * name:HOWL --> Equivalent to above. - # * NAME:howl --> Equivalent to above. - # * labels.env:* --> The instance has the label "env". - # * labels.env:dev --> The instance has the label "env" and the value of + # * `name:*` --> The instance has a name. + # * `name:Howl` --> The instance's name contains the string "howl". + # * `name:HOWL` --> Equivalent to above. + # * `NAME:howl` --> Equivalent to above. + # * `labels.env:*` --> The instance has the label "env". + # * `labels.env:dev` --> The instance has the label "env" and the value of # the label contains the string "dev". - # * name:howl labels.env:dev --> The instance's name contains "howl" and + # * `name:howl labels.env:dev` --> The instance's name contains "howl" and # it has the label "env" with its value # containing "dev". # @param [Fixnum] page_size @@ -1242,10 +1242,10 @@ module Google # @param [String] filter # An expression for filtering the results of the request. Filter rules are # case insensitive. The fields eligible for filtering are: - # * labels.key where key is the name of a label + # * `labels.key` where key is the name of a label # Some examples of using filters are: - # * labels.env:* --> The session has the label "env". - # * labels.env:dev --> The session has the label "env" and the value of + # * `labels.env:*` --> The session has the label "env". + # * `labels.env:dev` --> The session has the label "env" and the value of # the label contains the string "dev". # @param [Fixnum] page_size # Number of sessions to be returned in the response. If 0 or less, defaults diff --git a/generated/google/apis/speech_v1.rb b/generated/google/apis/speech_v1.rb index d90bbe2a2..64738c8f9 100644 --- a/generated/google/apis/speech_v1.rb +++ b/generated/google/apis/speech_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/speech/ module SpeechV1 VERSION = 'V1' - REVISION = '20170829' + REVISION = '20171018' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/speech_v1/classes.rb b/generated/google/apis/speech_v1/classes.rb index 0d97f8551..2e5381623 100644 --- a/generated/google/apis/speech_v1/classes.rb +++ b/generated/google/apis/speech_v1/classes.rb @@ -403,7 +403,8 @@ module Google # indicates an estimated greater likelihood that the recognized words are # correct. This field is typically provided only for the top hypothesis, and # only for `is_final=true` results. Clients should not rely on the - # `confidence` field as it is not guaranteed to be accurate or consistent. + # `confidence` field as it is not guaranteed to be accurate, or even set, in + # any of the results. # The default of 0.0 is a sentinel value indicating `confidence` was not set. # Corresponds to the JSON property `confidence` # @return [Float] @@ -443,6 +444,13 @@ module Google # @return [Array] attr_accessor :alternatives + # For multi-channel audio, this is the channel number corresponding to the + # recognized result for the audio from that channel. + # For audio_channel_count = N, its output values can range from '0' to 'N-1'. + # Corresponds to the JSON property `channelTag` + # @return [Fixnum] + attr_accessor :channel_tag + def initialize(**args) update!(**args) end @@ -450,6 +458,7 @@ module Google # Update properties of this object def update!(**args) @alternatives = args[:alternatives] if args.key?(:alternatives) + @channel_tag = args[:channel_tag] if args.key?(:channel_tag) end end diff --git a/generated/google/apis/speech_v1/representations.rb b/generated/google/apis/speech_v1/representations.rb index f8b038cd7..97f48e0b8 100644 --- a/generated/google/apis/speech_v1/representations.rb +++ b/generated/google/apis/speech_v1/representations.rb @@ -211,6 +211,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation collection :alternatives, as: 'alternatives', class: Google::Apis::SpeechV1::SpeechRecognitionAlternative, decorator: Google::Apis::SpeechV1::SpeechRecognitionAlternative::Representation + property :channel_tag, as: 'channelTag' end end diff --git a/generated/google/apis/sqladmin_v1beta4.rb b/generated/google/apis/sqladmin_v1beta4.rb index d55266598..fb1967ba4 100644 --- a/generated/google/apis/sqladmin_v1beta4.rb +++ b/generated/google/apis/sqladmin_v1beta4.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/sql/docs/reference/latest module SqladminV1beta4 VERSION = 'V1beta4' - REVISION = '20170807' + REVISION = '20171011' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/sqladmin_v1beta4/classes.rb b/generated/google/apis/sqladmin_v1beta4/classes.rb index 4cc92b96c..bef382c98 100644 --- a/generated/google/apis/sqladmin_v1beta4/classes.rb +++ b/generated/google/apis/sqladmin_v1beta4/classes.rb @@ -626,6 +626,114 @@ module Google end end + # Read-replica configuration for connecting to the on-premises master. + class DemoteMasterConfiguration + include Google::Apis::Core::Hashable + + # This is always sql#demoteMasterConfiguration. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Read-replica configuration specific to MySQL databases. + # Corresponds to the JSON property `mysqlReplicaConfiguration` + # @return [Google::Apis::SqladminV1beta4::DemoteMasterMySqlReplicaConfiguration] + attr_accessor :mysql_replica_configuration + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @mysql_replica_configuration = args[:mysql_replica_configuration] if args.key?(:mysql_replica_configuration) + end + end + + # Database instance demote master context. + class DemoteMasterContext + include Google::Apis::Core::Hashable + + # This is always sql#demoteMasterContext. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The name of the instance which will act as on-premises master in the + # replication setup. + # Corresponds to the JSON property `masterInstanceName` + # @return [String] + attr_accessor :master_instance_name + + # Read-replica configuration for connecting to the on-premises master. + # Corresponds to the JSON property `replicaConfiguration` + # @return [Google::Apis::SqladminV1beta4::DemoteMasterConfiguration] + attr_accessor :replica_configuration + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @master_instance_name = args[:master_instance_name] if args.key?(:master_instance_name) + @replica_configuration = args[:replica_configuration] if args.key?(:replica_configuration) + end + end + + # Read-replica configuration specific to MySQL databases. + class DemoteMasterMySqlReplicaConfiguration + include Google::Apis::Core::Hashable + + # PEM representation of the trusted CA's x509 certificate. + # Corresponds to the JSON property `caCertificate` + # @return [String] + attr_accessor :ca_certificate + + # PEM representation of the slave's x509 certificate. + # Corresponds to the JSON property `clientCertificate` + # @return [String] + attr_accessor :client_certificate + + # PEM representation of the slave's private key. The corresponsing public key is + # encoded in the client's certificate. The format of the slave's private key can + # be either PKCS #1 or PKCS #8. + # Corresponds to the JSON property `clientKey` + # @return [String] + attr_accessor :client_key + + # This is always sql#demoteMasterMysqlReplicaConfiguration. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The password for the replication connection. + # Corresponds to the JSON property `password` + # @return [String] + attr_accessor :password + + # The username for the replication connection. + # Corresponds to the JSON property `username` + # @return [String] + attr_accessor :username + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ca_certificate = args[:ca_certificate] if args.key?(:ca_certificate) + @client_certificate = args[:client_certificate] if args.key?(:client_certificate) + @client_key = args[:client_key] if args.key?(:client_key) + @kind = args[:kind] if args.key?(:kind) + @password = args[:password] if args.key?(:password) + @username = args[:username] if args.key?(:username) + end + end + # Database instance export context. class ExportContext include Google::Apis::Core::Hashable @@ -949,6 +1057,25 @@ module Google end end + # Database demote master request. + class InstancesDemoteMasterRequest + include Google::Apis::Core::Hashable + + # Database instance demote master context. + # Corresponds to the JSON property `demoteMasterContext` + # @return [Google::Apis::SqladminV1beta4::DemoteMasterContext] + attr_accessor :demote_master_context + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @demote_master_context = args[:demote_master_context] if args.key?(:demote_master_context) + end + end + # Database instance export request. class ExportInstancesRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/sqladmin_v1beta4/representations.rb b/generated/google/apis/sqladmin_v1beta4/representations.rb index c6a7e4f6d..69112c2dc 100644 --- a/generated/google/apis/sqladmin_v1beta4/representations.rb +++ b/generated/google/apis/sqladmin_v1beta4/representations.rb @@ -88,6 +88,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class DemoteMasterConfiguration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DemoteMasterContext + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DemoteMasterMySqlReplicaConfiguration + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ExportContext class Representation < Google::Apis::Core::JsonRepresentation; end @@ -142,6 +160,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class InstancesDemoteMasterRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ExportInstancesRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -471,6 +495,37 @@ module Google end end + class DemoteMasterConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :mysql_replica_configuration, as: 'mysqlReplicaConfiguration', class: Google::Apis::SqladminV1beta4::DemoteMasterMySqlReplicaConfiguration, decorator: Google::Apis::SqladminV1beta4::DemoteMasterMySqlReplicaConfiguration::Representation + + end + end + + class DemoteMasterContext + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :master_instance_name, as: 'masterInstanceName' + property :replica_configuration, as: 'replicaConfiguration', class: Google::Apis::SqladminV1beta4::DemoteMasterConfiguration, decorator: Google::Apis::SqladminV1beta4::DemoteMasterConfiguration::Representation + + end + end + + class DemoteMasterMySqlReplicaConfiguration + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ca_certificate, as: 'caCertificate' + property :client_certificate, as: 'clientCertificate' + property :client_key, as: 'clientKey' + property :kind, as: 'kind' + property :password, as: 'password' + property :username, as: 'username' + end + end + class ExportContext # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -560,6 +615,14 @@ module Google end end + class InstancesDemoteMasterRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :demote_master_context, as: 'demoteMasterContext', class: Google::Apis::SqladminV1beta4::DemoteMasterContext, decorator: Google::Apis::SqladminV1beta4::DemoteMasterContext::Representation + + end + end + class ExportInstancesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/sqladmin_v1beta4/service.rb b/generated/google/apis/sqladmin_v1beta4/service.rb index e46fbeb37..352c3177f 100644 --- a/generated/google/apis/sqladmin_v1beta4/service.rb +++ b/generated/google/apis/sqladmin_v1beta4/service.rb @@ -595,6 +595,48 @@ module Google execute_or_queue_command(command, &block) end + # Demotes the standalone instance to be a read replica Cloud SQL instance of an + # on-premises master. + # @param [String] project + # ID of the project that contains the instance. + # @param [String] instance + # Cloud SQL instance name. + # @param [Google::Apis::SqladminV1beta4::InstancesDemoteMasterRequest] instances_demote_master_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::SqladminV1beta4::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::SqladminV1beta4::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def demote_instance_master(project, instance, instances_demote_master_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'projects/{project}/instances/{instance}/demoteMaster', options) + command.request_representation = Google::Apis::SqladminV1beta4::InstancesDemoteMasterRequest::Representation + command.request_object = instances_demote_master_request_object + command.response_representation = Google::Apis::SqladminV1beta4::Operation::Representation + command.response_class = Google::Apis::SqladminV1beta4::Operation + command.params['project'] = project unless project.nil? + command.params['instance'] = instance unless instance.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Exports data from a Cloud SQL instance to a Google Cloud Storage bucket as a # MySQL dump file. # @param [String] project diff --git a/generated/google/apis/storage_v1.rb b/generated/google/apis/storage_v1.rb index 53076c0e5..5e35b638d 100644 --- a/generated/google/apis/storage_v1.rb +++ b/generated/google/apis/storage_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/storage/docs/json_api/ module StorageV1 VERSION = 'V1' - REVISION = '20170915' + REVISION = '20171018' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/storage_v1/service.rb b/generated/google/apis/storage_v1/service.rb index c650dd7ea..cabf54004 100644 --- a/generated/google/apis/storage_v1/service.rb +++ b/generated/google/apis/storage_v1/service.rb @@ -61,7 +61,7 @@ module Google # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -101,7 +101,7 @@ module Google # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -141,7 +141,7 @@ module Google # Name of a bucket. # @param [Google::Apis::StorageV1::BucketAccessControl] bucket_access_control_object # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -181,7 +181,7 @@ module Google # @param [String] bucket # Name of a bucket. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -224,7 +224,7 @@ module Google # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1::BucketAccessControl] bucket_access_control_object # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -269,7 +269,7 @@ module Google # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1::BucketAccessControl] bucket_access_control_object # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -315,7 +315,7 @@ module Google # If set, only deletes the bucket if its metageneration does not match this # value. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -361,7 +361,7 @@ module Google # @param [String] projection # Set of properties to return. Defaults to noAcl. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -402,7 +402,7 @@ module Google # @param [String] bucket # Name of a bucket. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -448,7 +448,7 @@ module Google # Set of properties to return. Defaults to noAcl, unless the bucket resource # specifies acl or defaultObjectAcl properties, when it defaults to full. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -501,7 +501,7 @@ module Google # @param [String] projection # Set of properties to return. Defaults to noAcl. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -558,7 +558,7 @@ module Google # @param [String] projection # Set of properties to return. Defaults to full. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -604,7 +604,7 @@ module Google # Name of a bucket. # @param [Google::Apis::StorageV1::Policy] policy_object # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -647,7 +647,7 @@ module Google # @param [Array, String] permissions # Permissions to test. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -700,7 +700,7 @@ module Google # @param [String] projection # Set of properties to return. Defaults to full. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -782,7 +782,7 @@ module Google # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -823,7 +823,7 @@ module Google # The entity holding the permission. Can be user-userId, user-emailAddress, # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -863,7 +863,7 @@ module Google # Name of a bucket. # @param [Google::Apis::StorageV1::ObjectAccessControl] object_access_control_object # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -909,7 +909,7 @@ module Google # If present, only return default ACL listing if the bucket's current # metageneration does not match the given value. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -954,7 +954,7 @@ module Google # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1::ObjectAccessControl] object_access_control_object # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -999,7 +999,7 @@ module Google # group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. # @param [Google::Apis::StorageV1::ObjectAccessControl] object_access_control_object # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1042,7 +1042,7 @@ module Google # @param [String] notification # ID of the notification to delete. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1081,7 +1081,7 @@ module Google # @param [String] notification # Notification ID # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1121,7 +1121,7 @@ module Google # The parent bucket of the notification. # @param [Google::Apis::StorageV1::Notification] notification_object # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1161,7 +1161,7 @@ module Google # @param [String] bucket # Name of a Google Cloud Storage bucket. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1209,7 +1209,7 @@ module Google # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1257,7 +1257,7 @@ module Google # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1305,7 +1305,7 @@ module Google # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1353,7 +1353,7 @@ module Google # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1404,7 +1404,7 @@ module Google # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1457,7 +1457,7 @@ module Google # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1517,7 +1517,7 @@ module Google # global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the # object. Overrides the object metadata's kms_key_name value, if any. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1527,8 +1527,6 @@ module Google # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. - # @param [IO, String] download_dest - # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1541,13 +1539,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def compose_object(destination_bucket, destination_object, compose_request_object = nil, destination_predefined_acl: nil, if_generation_match: nil, if_metageneration_match: nil, kms_key_name: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) - if download_dest.nil? - command = make_simple_command(:post, 'b/{destinationBucket}/o/{destinationObject}/compose', options) - else - command = make_download_command(:post, 'b/{destinationBucket}/o/{destinationObject}/compose', options) - command.download_dest = download_dest - end + def compose_object(destination_bucket, destination_object, compose_request_object = nil, destination_predefined_acl: nil, if_generation_match: nil, if_metageneration_match: nil, kms_key_name: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'b/{destinationBucket}/o/{destinationObject}/compose', options) command.request_representation = Google::Apis::StorageV1::ComposeRequest::Representation command.request_object = compose_request_object command.response_representation = Google::Apis::StorageV1::Object::Representation @@ -1615,7 +1608,7 @@ module Google # If present, selects a specific revision of the source object (as opposed to # the latest version, the default). # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1625,8 +1618,6 @@ module Google # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. - # @param [IO, String] download_dest - # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1639,13 +1630,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def copy_object(source_bucket, source_object, destination_bucket, destination_object, object_object = nil, destination_predefined_acl: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, if_source_generation_match: nil, if_source_generation_not_match: nil, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, projection: nil, source_generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) - if download_dest.nil? - command = make_simple_command(:post, 'b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}', options) - else - command = make_download_command(:post, 'b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}', options) - command.download_dest = download_dest - end + def copy_object(source_bucket, source_object, destination_bucket, destination_object, object_object = nil, destination_predefined_acl: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, if_source_generation_match: nil, if_source_generation_not_match: nil, if_source_metageneration_match: nil, if_source_metageneration_not_match: nil, projection: nil, source_generation: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:post, 'b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}', options) command.request_representation = Google::Apis::StorageV1::Object::Representation command.request_object = object_object command.response_representation = Google::Apis::StorageV1::Object::Representation @@ -1698,7 +1684,7 @@ module Google # Makes the operation conditional on whether the object's current metageneration # does not match the given value. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1763,7 +1749,7 @@ module Google # @param [String] projection # Set of properties to return. Defaults to noAcl. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1821,7 +1807,7 @@ module Google # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1897,7 +1883,7 @@ module Google # Set of properties to return. Defaults to noAcl, unless the object resource # specifies the acl property, when it defaults to full. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1974,7 +1960,7 @@ module Google # @param [String] projection # Set of properties to return. Defaults to noAcl. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [Boolean] versions # If true, lists all versions of an object as distinct results. The default is # false. For more information, see Object Versioning. @@ -2017,7 +2003,7 @@ module Google execute_or_queue_command(command, &block) end - # Updates an object's metadata. This method supports patch semantics. + # Patches an object's metadata. # @param [String] bucket # Name of the bucket in which the object resides. # @param [String] object @@ -2160,7 +2146,7 @@ module Google # If present, selects a specific revision of the source object (as opposed to # the latest version, the default). # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2224,7 +2210,7 @@ module Google # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2275,7 +2261,7 @@ module Google # If present, selects a specific revision of this object (as opposed to the # latest version, the default). # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2342,7 +2328,7 @@ module Google # @param [String] projection # Set of properties to return. Defaults to full. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2352,8 +2338,6 @@ module Google # @param [String] user_ip # IP address of the site where the request originates. Use this if you want to # enforce per-user limits. - # @param [IO, String] download_dest - # IO stream or filename to receive content download # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2366,13 +2350,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_object(bucket, object, object_object = nil, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, predefined_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block) - if download_dest.nil? - command = make_simple_command(:put, 'b/{bucket}/o/{object}', options) - else - command = make_download_command(:put, 'b/{bucket}/o/{object}', options) - command.download_dest = download_dest - end + def update_object(bucket, object, object_object = nil, generation: nil, if_generation_match: nil, if_generation_not_match: nil, if_metageneration_match: nil, if_metageneration_not_match: nil, predefined_acl: nil, projection: nil, user_project: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:put, 'b/{bucket}/o/{object}', options) command.request_representation = Google::Apis::StorageV1::Object::Representation command.request_object = object_object command.response_representation = Google::Apis::StorageV1::Object::Representation @@ -2416,7 +2395,7 @@ module Google # @param [String] projection # Set of properties to return. Defaults to noAcl. # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. Required for Requester Pays buckets. # @param [Boolean] versions # If true, lists all versions of an object as distinct results. The default is # false. For more information, see Object Versioning. @@ -2465,7 +2444,7 @@ module Google # @param [String] project_id # Project ID # @param [String] user_project - # The project to be billed for this request, for Requester Pays buckets. + # The project to be billed for this request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/storagetransfer_v1.rb b/generated/google/apis/storagetransfer_v1.rb index 3708d3ba1..399c95960 100644 --- a/generated/google/apis/storagetransfer_v1.rb +++ b/generated/google/apis/storagetransfer_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/storage/transfer module StoragetransferV1 VERSION = 'V1' - REVISION = '20170918' + REVISION = '20171109' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/storagetransfer_v1/classes.rb b/generated/google/apis/storagetransfer_v1/classes.rb index b39a52749..6ce55631d 100644 --- a/generated/google/apis/storagetransfer_v1/classes.rb +++ b/generated/google/apis/storagetransfer_v1/classes.rb @@ -719,8 +719,8 @@ module Google attr_accessor :bytes_failed_to_delete_from_sink # Bytes found in the data source that are scheduled to be transferred, - # which will be copied, excluded based on conditions, or skipped due to - # failures. + # excluding any that are filtered based on object conditions or skipped due + # to sync. # Corresponds to the JSON property `bytesFoundFromSource` # @return [Fixnum] attr_accessor :bytes_found_from_source @@ -762,8 +762,8 @@ module Google attr_accessor :objects_failed_to_delete_from_sink # Objects found in the data source that are scheduled to be transferred, - # which will be copied, excluded based on conditions, or skipped due to - # failures. + # excluding any that are filtered based on object conditions or skipped due + # to sync. # Corresponds to the JSON property `objectsFoundFromSource` # @return [Fixnum] attr_accessor :objects_found_from_source diff --git a/generated/google/apis/streetviewpublish_v1.rb b/generated/google/apis/streetviewpublish_v1.rb index f2c2273ce..602b40f09 100644 --- a/generated/google/apis/streetviewpublish_v1.rb +++ b/generated/google/apis/streetviewpublish_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://developers.google.com/streetview/publish/ module StreetviewpublishV1 VERSION = 'V1' - REVISION = '20170930' + REVISION = '20171101' # Publish and manage your 360 photos on Google Street View AUTH_STREETVIEWPUBLISH = 'https://www.googleapis.com/auth/streetviewpublish' diff --git a/generated/google/apis/streetviewpublish_v1/classes.rb b/generated/google/apis/streetviewpublish_v1/classes.rb index 66935726b..fb70c036b 100644 --- a/generated/google/apis/streetviewpublish_v1/classes.rb +++ b/generated/google/apis/streetviewpublish_v1/classes.rb @@ -172,36 +172,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) class LatLng include Google::Apis::Core::Hashable @@ -571,7 +541,7 @@ module Google class Pose include Google::Apis::Core::Hashable - # Altitude of the pose in meters above ground level (as defined by WGS84). + # Altitude of the pose in meters above WGS84 ellipsoid. # NaN indicates an unmeasured quantity. # Corresponds to the JSON property `altitude` # @return [Float] @@ -589,36 +559,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # Corresponds to the JSON property `latLngPair` # @return [Google::Apis::StreetviewpublishV1::LatLng] attr_accessor :lat_lng_pair diff --git a/generated/google/apis/streetviewpublish_v1/service.rb b/generated/google/apis/streetviewpublish_v1/service.rb index 6a75ae987..083c24640 100644 --- a/generated/google/apis/streetviewpublish_v1/service.rb +++ b/generated/google/apis/streetviewpublish_v1/service.rb @@ -61,7 +61,8 @@ module Google # `pose.altitude`, and `pose.level` fields in Pose are ignored for # CreatePhoto. # This method returns the following error codes: - # * google.rpc.Code.INVALID_ARGUMENT if the request is malformed. + # * google.rpc.Code.INVALID_ARGUMENT if the request is malformed or if + # the uploaded photo is not a 360 photo. # * google.rpc.Code.NOT_FOUND if the upload reference does not exist. # * google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the # storage limit. diff --git a/generated/google/apis/tagmanager_v1.rb b/generated/google/apis/tagmanager_v1.rb index 8228090de..25eba28ab 100644 --- a/generated/google/apis/tagmanager_v1.rb +++ b/generated/google/apis/tagmanager_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/tag-manager/api/v1/ module TagmanagerV1 VERSION = 'V1' - REVISION = '20160310' + REVISION = '20171108' # Delete your Google Tag Manager containers AUTH_TAGMANAGER_DELETE_CONTAINERS = 'https://www.googleapis.com/auth/tagmanager.delete.containers' diff --git a/generated/google/apis/tagmanager_v1/classes.rb b/generated/google/apis/tagmanager_v1/classes.rb index 95cad16e7..3bb052b84 100644 --- a/generated/google/apis/tagmanager_v1/classes.rb +++ b/generated/google/apis/tagmanager_v1/classes.rb @@ -1127,6 +1127,12 @@ module Google # @return [String] attr_accessor :parent_folder_id + # True if the tag is paused. + # Corresponds to the JSON property `paused` + # @return [Boolean] + attr_accessor :paused + alias_method :paused?, :paused + # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `priority` # @return [Google::Apis::TagmanagerV1::Parameter] @@ -1185,6 +1191,7 @@ module Google @notes = args[:notes] if args.key?(:notes) @parameter = args[:parameter] if args.key?(:parameter) @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) + @paused = args[:paused] if args.key?(:paused) @priority = args[:priority] if args.key?(:priority) @schedule_end_ms = args[:schedule_end_ms] if args.key?(:schedule_end_ms) @schedule_start_ms = args[:schedule_start_ms] if args.key?(:schedule_start_ms) @@ -1247,16 +1254,16 @@ module Google # @return [String] attr_accessor :container_id + # Represents a Google Tag Manager Parameter. + # Corresponds to the JSON property `continuousTimeMinMilliseconds` + # @return [Google::Apis::TagmanagerV1::Parameter] + attr_accessor :continuous_time_min_milliseconds + # Used in the case of custom event, which is fired iff all Conditions are true. # Corresponds to the JSON property `customEventFilter` # @return [Array] attr_accessor :custom_event_filter - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `enableAllVideos` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :enable_all_videos - # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `eventName` # @return [Google::Apis::TagmanagerV1::Parameter] @@ -1273,26 +1280,56 @@ module Google # @return [String] attr_accessor :fingerprint + # Represents a Google Tag Manager Parameter. + # Corresponds to the JSON property `horizontalScrollPercentageList` + # @return [Google::Apis::TagmanagerV1::Parameter] + attr_accessor :horizontal_scroll_percentage_list + # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `interval` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :interval + # Represents a Google Tag Manager Parameter. + # Corresponds to the JSON property `intervalSeconds` + # @return [Google::Apis::TagmanagerV1::Parameter] + attr_accessor :interval_seconds + # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `limit` # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :limit + # Represents a Google Tag Manager Parameter. + # Corresponds to the JSON property `maxTimerLengthSeconds` + # @return [Google::Apis::TagmanagerV1::Parameter] + attr_accessor :max_timer_length_seconds + # Trigger display name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name + # Additional parameters. + # Corresponds to the JSON property `parameter` + # @return [Array] + attr_accessor :parameter + # Parent folder id. # Corresponds to the JSON property `parentFolderId` # @return [String] attr_accessor :parent_folder_id + # Represents a Google Tag Manager Parameter. + # Corresponds to the JSON property `selector` + # @return [Google::Apis::TagmanagerV1::Parameter] + attr_accessor :selector + + # Represents a Google Tag Manager Parameter. + # Corresponds to the JSON property `totalTimeMinMilliseconds` + # @return [Google::Apis::TagmanagerV1::Parameter] + attr_accessor :total_time_min_milliseconds + # The Trigger ID uniquely identifies the GTM Trigger. # Corresponds to the JSON property `triggerId` # @return [String] @@ -1309,9 +1346,24 @@ module Google attr_accessor :unique_trigger_id # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `videoPercentageList` + # Corresponds to the JSON property `verticalScrollPercentageList` # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :video_percentage_list + attr_accessor :vertical_scroll_percentage_list + + # Represents a Google Tag Manager Parameter. + # Corresponds to the JSON property `visibilitySelector` + # @return [Google::Apis::TagmanagerV1::Parameter] + attr_accessor :visibility_selector + + # Represents a Google Tag Manager Parameter. + # Corresponds to the JSON property `visiblePercentageMax` + # @return [Google::Apis::TagmanagerV1::Parameter] + attr_accessor :visible_percentage_max + + # Represents a Google Tag Manager Parameter. + # Corresponds to the JSON property `visiblePercentageMin` + # @return [Google::Apis::TagmanagerV1::Parameter] + attr_accessor :visible_percentage_min # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `waitForTags` @@ -1333,19 +1385,28 @@ module Google @auto_event_filter = args[:auto_event_filter] if args.key?(:auto_event_filter) @check_validation = args[:check_validation] if args.key?(:check_validation) @container_id = args[:container_id] if args.key?(:container_id) + @continuous_time_min_milliseconds = args[:continuous_time_min_milliseconds] if args.key?(:continuous_time_min_milliseconds) @custom_event_filter = args[:custom_event_filter] if args.key?(:custom_event_filter) - @enable_all_videos = args[:enable_all_videos] if args.key?(:enable_all_videos) @event_name = args[:event_name] if args.key?(:event_name) @filter = args[:filter] if args.key?(:filter) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) + @horizontal_scroll_percentage_list = args[:horizontal_scroll_percentage_list] if args.key?(:horizontal_scroll_percentage_list) @interval = args[:interval] if args.key?(:interval) + @interval_seconds = args[:interval_seconds] if args.key?(:interval_seconds) @limit = args[:limit] if args.key?(:limit) + @max_timer_length_seconds = args[:max_timer_length_seconds] if args.key?(:max_timer_length_seconds) @name = args[:name] if args.key?(:name) + @parameter = args[:parameter] if args.key?(:parameter) @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) + @selector = args[:selector] if args.key?(:selector) + @total_time_min_milliseconds = args[:total_time_min_milliseconds] if args.key?(:total_time_min_milliseconds) @trigger_id = args[:trigger_id] if args.key?(:trigger_id) @type = args[:type] if args.key?(:type) @unique_trigger_id = args[:unique_trigger_id] if args.key?(:unique_trigger_id) - @video_percentage_list = args[:video_percentage_list] if args.key?(:video_percentage_list) + @vertical_scroll_percentage_list = args[:vertical_scroll_percentage_list] if args.key?(:vertical_scroll_percentage_list) + @visibility_selector = args[:visibility_selector] if args.key?(:visibility_selector) + @visible_percentage_max = args[:visible_percentage_max] if args.key?(:visible_percentage_max) + @visible_percentage_min = args[:visible_percentage_min] if args.key?(:visible_percentage_min) @wait_for_tags = args[:wait_for_tags] if args.key?(:wait_for_tags) @wait_for_tags_timeout = args[:wait_for_tags_timeout] if args.key?(:wait_for_tags_timeout) end diff --git a/generated/google/apis/tagmanager_v1/representations.rb b/generated/google/apis/tagmanager_v1/representations.rb index bafcf7cf2..ddb9637e3 100644 --- a/generated/google/apis/tagmanager_v1/representations.rb +++ b/generated/google/apis/tagmanager_v1/representations.rb @@ -515,6 +515,7 @@ module Google collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :parent_folder_id, as: 'parentFolderId' + property :paused, as: 'paused' property :priority, as: 'priority', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :schedule_end_ms, :numeric_string => true, as: 'scheduleEndMs' @@ -546,26 +547,44 @@ module Google property :check_validation, as: 'checkValidation', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :container_id, as: 'containerId' - collection :custom_event_filter, as: 'customEventFilter', class: Google::Apis::TagmanagerV1::Condition, decorator: Google::Apis::TagmanagerV1::Condition::Representation + property :continuous_time_min_milliseconds, as: 'continuousTimeMinMilliseconds', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - property :enable_all_videos, as: 'enableAllVideos', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation + collection :custom_event_filter, as: 'customEventFilter', class: Google::Apis::TagmanagerV1::Condition, decorator: Google::Apis::TagmanagerV1::Condition::Representation property :event_name, as: 'eventName', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation collection :filter, as: 'filter', class: Google::Apis::TagmanagerV1::Condition, decorator: Google::Apis::TagmanagerV1::Condition::Representation property :fingerprint, as: 'fingerprint' + property :horizontal_scroll_percentage_list, as: 'horizontalScrollPercentageList', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation + property :interval, as: 'interval', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation + property :interval_seconds, as: 'intervalSeconds', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation + property :limit, as: 'limit', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation + property :max_timer_length_seconds, as: 'maxTimerLengthSeconds', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation + property :name, as: 'name' + collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation + property :parent_folder_id, as: 'parentFolderId' + property :selector, as: 'selector', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation + + property :total_time_min_milliseconds, as: 'totalTimeMinMilliseconds', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation + property :trigger_id, as: 'triggerId' property :type, as: 'type' property :unique_trigger_id, as: 'uniqueTriggerId', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - property :video_percentage_list, as: 'videoPercentageList', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation + property :vertical_scroll_percentage_list, as: 'verticalScrollPercentageList', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation + + property :visibility_selector, as: 'visibilitySelector', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation + + property :visible_percentage_max, as: 'visiblePercentageMax', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation + + property :visible_percentage_min, as: 'visiblePercentageMin', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation property :wait_for_tags, as: 'waitForTags', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation diff --git a/generated/google/apis/tagmanager_v2.rb b/generated/google/apis/tagmanager_v2.rb index 326d74202..da7852b20 100644 --- a/generated/google/apis/tagmanager_v2.rb +++ b/generated/google/apis/tagmanager_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/tag-manager/api/v2/ module TagmanagerV2 VERSION = 'V2' - REVISION = '20170915' + REVISION = '20171108' # Delete your Google Tag Manager containers AUTH_TAGMANAGER_DELETE_CONTAINERS = 'https://www.googleapis.com/auth/tagmanager.delete.containers' diff --git a/generated/google/apis/tagmanager_v2/classes.rb b/generated/google/apis/tagmanager_v2/classes.rb index 36bac4160..84005cb9a 100644 --- a/generated/google/apis/tagmanager_v2/classes.rb +++ b/generated/google/apis/tagmanager_v2/classes.rb @@ -1587,6 +1587,12 @@ module Google # @return [String] attr_accessor :path + # Indicates whether the tag is paused, which prevents the tag from firing. + # Corresponds to the JSON property `paused` + # @return [Boolean] + attr_accessor :paused + alias_method :paused?, :paused + # Represents a Google Tag Manager Parameter. # Corresponds to the JSON property `priority` # @return [Google::Apis::TagmanagerV2::Parameter] @@ -1656,6 +1662,7 @@ module Google @parameter = args[:parameter] if args.key?(:parameter) @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) @path = args[:path] if args.key?(:path) + @paused = args[:paused] if args.key?(:paused) @priority = args[:priority] if args.key?(:priority) @schedule_end_ms = args[:schedule_end_ms] if args.key?(:schedule_end_ms) @schedule_start_ms = args[:schedule_start_ms] if args.key?(:schedule_start_ms) diff --git a/generated/google/apis/tagmanager_v2/representations.rb b/generated/google/apis/tagmanager_v2/representations.rb index ec879b60f..32ff978ae 100644 --- a/generated/google/apis/tagmanager_v2/representations.rb +++ b/generated/google/apis/tagmanager_v2/representations.rb @@ -812,6 +812,7 @@ module Google property :parent_folder_id, as: 'parentFolderId' property :path, as: 'path' + property :paused, as: 'paused' property :priority, as: 'priority', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation property :schedule_end_ms, :numeric_string => true, as: 'scheduleEndMs' diff --git a/generated/google/apis/testing_v1.rb b/generated/google/apis/testing_v1.rb index a87e40243..ceb27dc43 100644 --- a/generated/google/apis/testing_v1.rb +++ b/generated/google/apis/testing_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/cloud-test-lab/ module TestingV1 VERSION = 'V1' - REVISION = '20170905' + REVISION = '20171012' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/testing_v1/classes.rb b/generated/google/apis/testing_v1/classes.rb index b4d81148e..fbc97f468 100644 --- a/generated/google/apis/testing_v1/classes.rb +++ b/generated/google/apis/testing_v1/classes.rb @@ -1342,9 +1342,13 @@ module Google # @return [Google::Apis::TestingV1::Account] attr_accessor :account - # The directories on the device to upload to GCS at the end of the test; - # they must be absolute, whitelisted paths. - # Refer to RegularFile for whitelisted paths. + # List of directories on the device to upload to GCS at the end of the test; + # they must be absolute paths under /sdcard or /data/local/tmp. + # Path names are restricted to characters a-z A-Z 0-9 _ - . + and / + # Note: The paths /sdcard and /data will be made available and treated as + # implicit path substitutions. E.g. if /sdcard on a particular device does + # not map to external storage, the system will replace it with the external + # storage path prefix for that device. # Optional # Corresponds to the JSON property `directoriesToPull` # @return [Array] @@ -1356,6 +1360,7 @@ module Google # @return [Array] attr_accessor :environment_variables + # List of files to push to the device before starting the test. # Optional # Corresponds to the JSON property `filesToPush` # @return [Array] diff --git a/generated/google/apis/toolresults_v1beta3.rb b/generated/google/apis/toolresults_v1beta3.rb index 289690331..3aa64bd2b 100644 --- a/generated/google/apis/toolresults_v1beta3.rb +++ b/generated/google/apis/toolresults_v1beta3.rb @@ -25,7 +25,7 @@ module Google # @see https://firebase.google.com/docs/test-lab/ module ToolresultsV1beta3 VERSION = 'V1beta3' - REVISION = '20171006' + REVISION = '20171113' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/toolresults_v1beta3/classes.rb b/generated/google/apis/toolresults_v1beta3/classes.rb index 41500f400..10460e28a 100644 --- a/generated/google/apis/toolresults_v1beta3/classes.rb +++ b/generated/google/apis/toolresults_v1beta3/classes.rb @@ -84,10 +84,7 @@ module Google attr_accessor :test_targets # The flag indicates whether Android Test Orchestrator will be used to run test - # or not. Test orchestrator is used if either: - orchestrator_option field is - # USE_ORCHESTRATOR, and test runner is compatible with orchestrator. Or - - # orchestrator_option field is unspecified or ORCHESTRATOR_OPTION_UNSPECIFIED, - # and test runner is compatible with orchestrator. + # or not. # Corresponds to the JSON property `useOrchestrator` # @return [Boolean] attr_accessor :use_orchestrator @@ -254,18 +251,22 @@ module Google class Any include Google::Apis::Core::Hashable - # A URL/resource name whose content describes the type of the serialized - # protocol buffer message. - # For URLs which use the scheme `http`, `https`, or no scheme, the following - # restrictions and interpretations apply: - # * If no scheme is provided, `https` is assumed. * The last segment of the URL' - # s path must represent the fully qualified name of the type (as in `path/google. - # protobuf.Duration`). The name should be in a canonical form (e.g., leading "." - # is not accepted). * An HTTP GET on the URL must yield a [google.protobuf.Type][ - # ] value in binary format, or produce an error. * Applications are allowed to - # cache lookup results based on the URL, or have them precompiled into a binary - # to avoid any lookup. Therefore, binary compatibility needs to be preserved on - # changes to types. (Use versioned type names to manage breaking changes.) + # A URL/resource name that uniquely identifies the type of the serialized + # protocol buffer message. The last segment of the URL's path must represent the + # fully qualified name of the type (as in `path/google.protobuf.Duration`). The + # name should be in a canonical form (e.g., leading "." is not accepted). + # In practice, teams usually precompile into the binary all types that they + # expect it to use in the context of Any. However, for URLs which use the scheme + # `http`, `https`, or no scheme, one can optionally set up a type server that + # maps type URLs to message definitions as follows: + # * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must + # yield a [google.protobuf.Type][] value in binary format, or produce an error. * + # Applications are allowed to cache lookup results based on the URL, or have + # them precompiled into a binary to avoid any lookup. Therefore, binary + # compatibility needs to be preserved on changes to types. (Use versioned type + # names to manage breaking changes.) + # Note: this functionality is not currently available in the official protobuf + # release, and it is not used for type URLs beginning with type.googleapis.com. # Schemes other than `http`, `https` (or the empty scheme) might be used with # implementation specific semantics. # Corresponds to the JSON property `typeUrl` @@ -589,9 +590,9 @@ module Google # datetime.datetime` object can be converted to this format using [`strftime`]( # https://docs.python.org/2/library/time.html#time.strftime) with the time # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://joda-time.sourceforge.net/ - # apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()) to obtain a - # formatter capable of generating timestamps in this format. + # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ + # org/joda/time/format/ISODateTimeFormat.html#dateTime-- ) to obtain a formatter + # capable of generating timestamps in this format. # Corresponds to the JSON property `completionTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :completion_time @@ -643,9 +644,9 @@ module Google # datetime.datetime` object can be converted to this format using [`strftime`]( # https://docs.python.org/2/library/time.html#time.strftime) with the time # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://joda-time.sourceforge.net/ - # apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()) to obtain a - # formatter capable of generating timestamps in this format. + # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ + # org/joda/time/format/ISODateTimeFormat.html#dateTime-- ) to obtain a formatter + # capable of generating timestamps in this format. # Corresponds to the JSON property `creationTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :creation_time @@ -1438,9 +1439,9 @@ module Google # datetime.datetime` object can be converted to this format using [`strftime`]( # https://docs.python.org/2/library/time.html#time.strftime) with the time # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://joda-time.sourceforge.net/ - # apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()) to obtain a - # formatter capable of generating timestamps in this format. + # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ + # org/joda/time/format/ISODateTimeFormat.html#dateTime-- ) to obtain a formatter + # capable of generating timestamps in this format. # Corresponds to the JSON property `sampleTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :sample_time @@ -1858,9 +1859,9 @@ module Google # datetime.datetime` object can be converted to this format using [`strftime`]( # https://docs.python.org/2/library/time.html#time.strftime) with the time # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://joda-time.sourceforge.net/ - # apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()) to obtain a - # formatter capable of generating timestamps in this format. + # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ + # org/joda/time/format/ISODateTimeFormat.html#dateTime-- ) to obtain a formatter + # capable of generating timestamps in this format. # Corresponds to the JSON property `completionTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :completion_time @@ -1912,9 +1913,9 @@ module Google # datetime.datetime` object can be converted to this format using [`strftime`]( # https://docs.python.org/2/library/time.html#time.strftime) with the time # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://joda-time.sourceforge.net/ - # apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()) to obtain a - # formatter capable of generating timestamps in this format. + # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ + # org/joda/time/format/ISODateTimeFormat.html#dateTime-- ) to obtain a formatter + # capable of generating timestamps in this format. # Corresponds to the JSON property `creationTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :creation_time @@ -2542,9 +2543,9 @@ module Google # datetime.datetime` object can be converted to this format using [`strftime`]( # https://docs.python.org/2/library/time.html#time.strftime) with the time # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://joda-time.sourceforge.net/ - # apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()) to obtain a - # formatter capable of generating timestamps in this format. + # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ + # org/joda/time/format/ISODateTimeFormat.html#dateTime-- ) to obtain a formatter + # capable of generating timestamps in this format. class Timestamp include Google::Apis::Core::Hashable @@ -2715,9 +2716,9 @@ module Google # datetime.datetime` object can be converted to this format using [`strftime`]( # https://docs.python.org/2/library/time.html#time.strftime) with the time # format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda - # Time's [`ISODateTimeFormat.dateTime()`]( http://joda-time.sourceforge.net/ - # apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()) to obtain a - # formatter capable of generating timestamps in this format. + # Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/ + # org/joda/time/format/ISODateTimeFormat.html#dateTime-- ) to obtain a formatter + # capable of generating timestamps in this format. # Corresponds to the JSON property `creationTime` # @return [Google::Apis::ToolresultsV1beta3::Timestamp] attr_accessor :creation_time diff --git a/generated/google/apis/qpx_express_v1.rb b/generated/google/apis/tpu_v1alpha1.rb similarity index 55% rename from generated/google/apis/qpx_express_v1.rb rename to generated/google/apis/tpu_v1alpha1.rb index 9f34ae7d9..ff703c1d4 100644 --- a/generated/google/apis/qpx_express_v1.rb +++ b/generated/google/apis/tpu_v1alpha1.rb @@ -12,20 +12,23 @@ # See the License for the specific language governing permissions and # limitations under the License. -require 'google/apis/qpx_express_v1/service.rb' -require 'google/apis/qpx_express_v1/classes.rb' -require 'google/apis/qpx_express_v1/representations.rb' +require 'google/apis/tpu_v1alpha1/service.rb' +require 'google/apis/tpu_v1alpha1/classes.rb' +require 'google/apis/tpu_v1alpha1/representations.rb' module Google module Apis - # QPX Express API + # Cloud TPU API # - # Finds the least expensive flights between an origin and a destination. + # TPU API provides customers with access to Google TPU technology. # - # @see http://developers.google.com/qpx-express - module QpxExpressV1 - VERSION = 'V1' - REVISION = '20160708' + # @see https://cloud.google.com/tpu/ + module TpuV1alpha1 + VERSION = 'V1alpha1' + REVISION = '20171121' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' end end end diff --git a/generated/google/apis/tpu_v1alpha1/classes.rb b/generated/google/apis/tpu_v1alpha1/classes.rb new file mode 100644 index 000000000..b4595f7d4 --- /dev/null +++ b/generated/google/apis/tpu_v1alpha1/classes.rb @@ -0,0 +1,562 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module TpuV1alpha1 + + # 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); + # ` + # The JSON representation for `Empty` is empty JSON object ````. + class Empty + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # The response message for Locations.ListLocations. + class ListLocationsResponse + include Google::Apis::Core::Hashable + + # A list of locations that matches the specified filter in the request. + # Corresponds to the JSON property `locations` + # @return [Array] + attr_accessor :locations + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @locations = args[:locations] if args.key?(:locations) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Response for ListNodes. + class ListNodesResponse + include Google::Apis::Core::Hashable + + # The next page token or empty if none. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The listed nodes. + # Corresponds to the JSON property `nodes` + # @return [Array] + attr_accessor :nodes + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @nodes = args[:nodes] if args.key?(:nodes) + end + end + + # The response message for Operations.ListOperations. + class ListOperationsResponse + include Google::Apis::Core::Hashable + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of operations that matches the specified filter in the request. + # Corresponds to the JSON property `operations` + # @return [Array] + attr_accessor :operations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @operations = args[:operations] if args.key?(:operations) + end + end + + # A resource that represents Google Cloud Platform location. + class Location + include Google::Apis::Core::Hashable + + # Cross-service attributes for the location. For example + # `"cloud.googleapis.com/region": "us-east1"` + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + + # The canonical id for this location. For example: `"us-east1"`. + # Corresponds to the JSON property `locationId` + # @return [String] + attr_accessor :location_id + + # Service-specific metadata. For example the available capacity at the given + # location. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # Resource name for the location, which may vary between implementations. + # For example: `"projects/example-project/locations/us-east1"` + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @labels = args[:labels] if args.key?(:labels) + @location_id = args[:location_id] if args.key?(:location_id) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + end + end + + # A network endpoint over which a TPU worker can be reached. + class NetworkEndpoint + include Google::Apis::Core::Hashable + + # The IP address of this network endpoint. + # Corresponds to the JSON property `ipAddress` + # @return [String] + attr_accessor :ip_address + + # The port of this network endpoint. + # Corresponds to the JSON property `port` + # @return [Fixnum] + attr_accessor :port + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ip_address = args[:ip_address] if args.key?(:ip_address) + @port = args[:port] if args.key?(:port) + end + end + + # A TPU instance. + class Node + include Google::Apis::Core::Hashable + + # The type of hardware accelerators associated with this node. + # Required. + # Corresponds to the JSON property `acceleratorType` + # @return [String] + attr_accessor :accelerator_type + + # The CIDR block that the TPU node will use when selecting //an IP address. + # This CIDR block must be a /29 block; the GCE networks API forbids a smaller + # block, and using a larger block would be wasteful (a node can only consume + # one IP address). Errors will occur if the CIDR block has already been used + # for a currently existing TPU node, the CIDR block conflicts with any + # subnetworks in the user's provided network, or the provided network is + # peered with another network that is using that CIDR block. + # Required. + # Corresponds to the JSON property `cidrBlock` + # @return [String] + attr_accessor :cidr_block + + # The time when the node was created. + # Output only. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # The user-supplied description of the TPU. Maximum of 512 characters. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # If this field is populated, it contains a description of why the TPU Node + # is unhealthy. + # Output only. + # Corresponds to the JSON property `healthDescription` + # @return [String] + attr_accessor :health_description + + # Output only. + # DEPRECATED! Use network_endpoints instead. + # The network address for the TPU Node as visible to GCE instances. + # Corresponds to the JSON property `ipAddress` + # @return [String] + attr_accessor :ip_address + + # The immutable name of the TPU + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The name of a network they wish to peer the TPU node to. It must be a + # preexisting GCE network inside of the project on which this API has been + # activated. If none is provided, "default" will be used. + # Corresponds to the JSON property `network` + # @return [String] + attr_accessor :network + + # Output only. The network endpoints where TPU workers can be accessed and sent + # work. + # It is recommended that Tensorflow clients of the node reach out to the 0th + # entry in this map first. + # Corresponds to the JSON property `networkEndpoints` + # @return [Array] + attr_accessor :network_endpoints + + # Output only. + # DEPRECATED! Use network_endpoints instead. + # The network port for the TPU Node as visible to GCE instances. + # Corresponds to the JSON property `port` + # @return [String] + attr_accessor :port + + # The service account used to run the tensor flow services within the node. + # To share resources, including Google Cloud Storage data, with the + # Tensorflow job running in the Node, this account must have permissions to + # that data. + # Output only. + # Corresponds to the JSON property `serviceAccount` + # @return [String] + attr_accessor :service_account + + # The current state for the TPU Node. + # Output only. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # The version of Tensorflow running in the Node. + # Required. + # Corresponds to the JSON property `tensorflowVersion` + # @return [String] + attr_accessor :tensorflow_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @accelerator_type = args[:accelerator_type] if args.key?(:accelerator_type) + @cidr_block = args[:cidr_block] if args.key?(:cidr_block) + @create_time = args[:create_time] if args.key?(:create_time) + @description = args[:description] if args.key?(:description) + @health_description = args[:health_description] if args.key?(:health_description) + @ip_address = args[:ip_address] if args.key?(:ip_address) + @name = args[:name] if args.key?(:name) + @network = args[:network] if args.key?(:network) + @network_endpoints = args[:network_endpoints] if args.key?(:network_endpoints) + @port = args[:port] if args.key?(:port) + @service_account = args[:service_account] if args.key?(:service_account) + @state = args[:state] if args.key?(:state) + @tensorflow_version = args[:tensorflow_version] if args.key?(:tensorflow_version) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + class Operation + include Google::Apis::Core::Hashable + + # If the value is `false`, it means the operation is still in progress. + # If `true`, the operation is completed, and either `error` or `response` is + # available. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by + # [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error message, + # and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + # Corresponds to the JSON property `error` + # @return [Google::Apis::TpuV1alpha1::Status] + attr_accessor :error + + # Service-specific metadata associated with the operation. It typically + # contains progress information and common metadata such as create time. + # Some services might not provide such metadata. Any method that returns a + # long-running operation should document the metadata type, if any. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # The server-assigned name, which is only unique within the same service that + # originally returns it. If you use the default HTTP mapping, the + # `name` should have the format of `operations/some/unique/name`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is + # `google.protobuf.Empty`. If the original method is standard + # `Get`/`Create`/`Update`, the response should be the resource. For other + # methods, the response should have the type `XxxResponse`, where `Xxx` + # is the original method name. For example, if the original method name + # is `TakeSnapshot()`, the inferred response type is + # `TakeSnapshotResponse`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @response = args[:response] if args.key?(:response) + end + end + + # Represents the metadata of the long-running operation. + class OperationMetadata + include Google::Apis::Core::Hashable + + # [Output only] API version used to start the operation. + # Corresponds to the JSON property `apiVersion` + # @return [String] + attr_accessor :api_version + + # [Output only] Identifies whether the user has requested cancellation + # of the operation. Operations that have successfully been cancelled + # have Operation.error value with a google.rpc.Status.code of 1, + # corresponding to `Code.CANCELLED`. + # Corresponds to the JSON property `cancelRequested` + # @return [Boolean] + attr_accessor :cancel_requested + alias_method :cancel_requested?, :cancel_requested + + # [Output only] The time the operation was created. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # [Output only] The time the operation finished running. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # [Output only] Human-readable status of the operation, if any. + # Corresponds to the JSON property `statusDetail` + # @return [String] + attr_accessor :status_detail + + # [Output only] Server-defined resource path for the target of the operation. + # Corresponds to the JSON property `target` + # @return [String] + attr_accessor :target + + # [Output only] Name of the verb executed by the operation. + # Corresponds to the JSON property `verb` + # @return [String] + attr_accessor :verb + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @api_version = args[:api_version] if args.key?(:api_version) + @cancel_requested = args[:cancel_requested] if args.key?(:cancel_requested) + @create_time = args[:create_time] if args.key?(:create_time) + @end_time = args[:end_time] if args.key?(:end_time) + @status_detail = args[:status_detail] if args.key?(:status_detail) + @target = args[:target] if args.key?(:target) + @verb = args[:verb] if args.key?(:verb) + end + end + + # Request for ReimageNode. + class ReimageNodeRequest + include Google::Apis::Core::Hashable + + # The version for reimage to create. + # Corresponds to the JSON property `tensorflowVersion` + # @return [String] + attr_accessor :tensorflow_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @tensorflow_version = args[:tensorflow_version] if args.key?(:tensorflow_version) + end + end + + # Request for ResetNode. + class ResetNodeRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by + # [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error message, + # and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + class Status + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # A developer-facing error message, which should be in English. Any + # user-facing error message should be localized and sent in the + # google.rpc.Status.details field, or localized by the client. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + end + end +end diff --git a/generated/google/apis/tpu_v1alpha1/representations.rb b/generated/google/apis/tpu_v1alpha1/representations.rb new file mode 100644 index 000000000..ac1671f28 --- /dev/null +++ b/generated/google/apis/tpu_v1alpha1/representations.rb @@ -0,0 +1,216 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module TpuV1alpha1 + + class Empty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListLocationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListNodesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Location + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NetworkEndpoint + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Node + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Operation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class OperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ReimageNodeRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResetNodeRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class ListLocationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :locations, as: 'locations', class: Google::Apis::TpuV1alpha1::Location, decorator: Google::Apis::TpuV1alpha1::Location::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListNodesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :nodes, as: 'nodes', class: Google::Apis::TpuV1alpha1::Node, decorator: Google::Apis::TpuV1alpha1::Node::Representation + + end + end + + class ListOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::TpuV1alpha1::Operation, decorator: Google::Apis::TpuV1alpha1::Operation::Representation + + end + end + + class Location + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :labels, as: 'labels' + property :location_id, as: 'locationId' + hash :metadata, as: 'metadata' + property :name, as: 'name' + end + end + + class NetworkEndpoint + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ip_address, as: 'ipAddress' + property :port, as: 'port' + end + end + + class Node + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :accelerator_type, as: 'acceleratorType' + property :cidr_block, as: 'cidrBlock' + property :create_time, as: 'createTime' + property :description, as: 'description' + property :health_description, as: 'healthDescription' + property :ip_address, as: 'ipAddress' + property :name, as: 'name' + property :network, as: 'network' + collection :network_endpoints, as: 'networkEndpoints', class: Google::Apis::TpuV1alpha1::NetworkEndpoint, decorator: Google::Apis::TpuV1alpha1::NetworkEndpoint::Representation + + property :port, as: 'port' + property :service_account, as: 'serviceAccount' + property :state, as: 'state' + property :tensorflow_version, as: 'tensorflowVersion' + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::TpuV1alpha1::Status, decorator: Google::Apis::TpuV1alpha1::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class OperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :api_version, as: 'apiVersion' + property :cancel_requested, as: 'cancelRequested' + property :create_time, as: 'createTime' + property :end_time, as: 'endTime' + property :status_detail, as: 'statusDetail' + property :target, as: 'target' + property :verb, as: 'verb' + end + end + + class ReimageNodeRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :tensorflow_version, as: 'tensorflowVersion' + end + end + + class ResetNodeRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + end + end +end diff --git a/generated/google/apis/tpu_v1alpha1/service.rb b/generated/google/apis/tpu_v1alpha1/service.rb new file mode 100644 index 000000000..d48c5371c --- /dev/null +++ b/generated/google/apis/tpu_v1alpha1/service.rb @@ -0,0 +1,477 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module TpuV1alpha1 + # Cloud TPU API + # + # TPU API provides customers with access to Google TPU technology. + # + # @example + # require 'google/apis/tpu_v1alpha1' + # + # Tpu = Google::Apis::TpuV1alpha1 # Alias the module + # service = Tpu::TPUService.new + # + # @see https://cloud.google.com/tpu/ + class TPUService < Google::Apis::Core::BaseService + # @return [String] + # 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. + attr_accessor :key + + # @return [String] + # 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. + attr_accessor :quota_user + + def initialize + super('https://tpu.googleapis.com/', '') + @batch_path = 'batch' + end + + # Get information about a location. + # @param [String] name + # Resource name for the location. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::TpuV1alpha1::Location] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::TpuV1alpha1::Location] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+name}', options) + command.response_representation = Google::Apis::TpuV1alpha1::Location::Representation + command.response_class = Google::Apis::TpuV1alpha1::Location + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists information about the supported locations for this service. + # @param [String] name + # The resource that owns the locations collection, if applicable. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::TpuV1alpha1::ListLocationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::TpuV1alpha1::ListLocationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+name}/locations', options) + command.response_representation = Google::Apis::TpuV1alpha1::ListLocationsResponse::Representation + command.response_class = Google::Apis::TpuV1alpha1::ListLocationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a node. + # @param [String] parent + # The parent resource name. + # @param [Google::Apis::TpuV1alpha1::Node] node_object + # @param [String] node_id + # The unqualified resource name. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::TpuV1alpha1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::TpuV1alpha1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_project_location_node(parent, node_object = nil, node_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+parent}/nodes', options) + command.request_representation = Google::Apis::TpuV1alpha1::Node::Representation + command.request_object = node_object + command.response_representation = Google::Apis::TpuV1alpha1::Operation::Representation + command.response_class = Google::Apis::TpuV1alpha1::Operation + command.params['parent'] = parent unless parent.nil? + command.query['nodeId'] = node_id unless node_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a node. + # @param [String] name + # The resource name. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::TpuV1alpha1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::TpuV1alpha1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_node(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha1/{+name}', options) + command.response_representation = Google::Apis::TpuV1alpha1::Operation::Representation + command.response_class = Google::Apis::TpuV1alpha1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the details of a node. + # @param [String] name + # The resource name. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::TpuV1alpha1::Node] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::TpuV1alpha1::Node] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_node(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+name}', options) + command.response_representation = Google::Apis::TpuV1alpha1::Node::Representation + command.response_class = Google::Apis::TpuV1alpha1::Node + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists nodes. + # @param [String] parent + # The parent resource name. + # @param [Fixnum] page_size + # The maximum number of items to return. + # @param [String] page_token + # The next_page_token value returned from a previous List request, if any. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::TpuV1alpha1::ListNodesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::TpuV1alpha1::ListNodesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_nodes(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+parent}/nodes', options) + command.response_representation = Google::Apis::TpuV1alpha1::ListNodesResponse::Representation + command.response_class = Google::Apis::TpuV1alpha1::ListNodesResponse + command.params['parent'] = parent unless parent.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Reimage a node's OS. + # @param [String] name + # The resource name. + # @param [Google::Apis::TpuV1alpha1::ReimageNodeRequest] reimage_node_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::TpuV1alpha1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::TpuV1alpha1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def reimage_project_location_node(name, reimage_node_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+name}:reimage', options) + command.request_representation = Google::Apis::TpuV1alpha1::ReimageNodeRequest::Representation + command.request_object = reimage_node_request_object + command.response_representation = Google::Apis::TpuV1alpha1::Operation::Representation + command.response_class = Google::Apis::TpuV1alpha1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Resets a node, which stops and starts the VM. + # @param [String] name + # The resource name. + # @param [Google::Apis::TpuV1alpha1::ResetNodeRequest] reset_node_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::TpuV1alpha1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::TpuV1alpha1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def reset_project_location_node(name, reset_node_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+name}:reset', options) + command.request_representation = Google::Apis::TpuV1alpha1::ResetNodeRequest::Representation + command.request_object = reset_node_request_object + command.response_representation = Google::Apis::TpuV1alpha1::Operation::Representation + command.response_class = Google::Apis::TpuV1alpha1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Starts asynchronous cancellation on a long-running operation. The server + # makes a best effort to cancel the operation, but success is not + # guaranteed. If the server doesn't support this method, it returns + # `google.rpc.Code.UNIMPLEMENTED`. Clients can use + # Operations.GetOperation or + # other methods to check whether the cancellation succeeded or whether the + # operation completed despite cancellation. On successful cancellation, + # the operation is not deleted; instead, it becomes an operation with + # an Operation.error value with a google.rpc.Status.code of 1, + # corresponding to `Code.CANCELLED`. + # @param [String] name + # The name of the operation resource to be cancelled. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::TpuV1alpha1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::TpuV1alpha1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1alpha1/{+name}:cancel', options) + command.response_representation = Google::Apis::TpuV1alpha1::Empty::Representation + command.response_class = Google::Apis::TpuV1alpha1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes a long-running operation. This method indicates that the client is + # no longer interested in the operation result. It does not cancel the + # operation. If the server doesn't support this method, it returns + # `google.rpc.Code.UNIMPLEMENTED`. + # @param [String] name + # The name of the operation resource to be deleted. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::TpuV1alpha1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::TpuV1alpha1::Empty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1alpha1/{+name}', options) + command.response_representation = Google::Apis::TpuV1alpha1::Empty::Representation + command.response_class = Google::Apis::TpuV1alpha1::Empty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of a long-running operation. Clients can use this + # method to poll the operation result at intervals as recommended by the API + # service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::TpuV1alpha1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::TpuV1alpha1::Operation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+name}', options) + command.response_representation = Google::Apis::TpuV1alpha1::Operation::Representation + command.response_class = Google::Apis::TpuV1alpha1::Operation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists operations that match the specified filter in the request. If the + # server doesn't support this method, it returns `UNIMPLEMENTED`. + # NOTE: the `name` binding allows API services to override the binding + # to use different resource name schemes, such as `users/*/operations`. To + # override the binding, API services can add a binding such as + # `"/v1/`name=users/*`/operations"` to their service configuration. + # For backwards compatibility, the default name includes the operations + # collection id, however overriding users must ensure the name binding + # is the parent resource, without the operations collection id. + # @param [String] name + # The name of the operation's parent resource. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::TpuV1alpha1::ListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::TpuV1alpha1::ListOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1alpha1/{+name}/operations', options) + command.response_representation = Google::Apis::TpuV1alpha1::ListOperationsResponse::Representation + command.response_class = Google::Apis::TpuV1alpha1::ListOperationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/vault_v1.rb b/generated/google/apis/vault_v1.rb index d2734e02c..120675072 100644 --- a/generated/google/apis/vault_v1.rb +++ b/generated/google/apis/vault_v1.rb @@ -20,12 +20,18 @@ module Google module Apis # Google Vault API # - # + # Archiving and eDiscovery for G Suite. # - # @see https://apps.google.com/products/vault/ + # @see https://developers.google.com/vault module VaultV1 VERSION = 'V1' - REVISION = '20170828' + REVISION = '20171026' + + # Manage your eDiscovery data + AUTH_EDISCOVERY = 'https://www.googleapis.com/auth/ediscovery' + + # View your eDiscovery data + AUTH_EDISCOVERY_READONLY = 'https://www.googleapis.com/auth/ediscovery.readonly' end end end diff --git a/generated/google/apis/vault_v1/classes.rb b/generated/google/apis/vault_v1/classes.rb index 68af8e7a6..d46ad5243 100644 --- a/generated/google/apis/vault_v1/classes.rb +++ b/generated/google/apis/vault_v1/classes.rb @@ -195,13 +195,13 @@ module Google class HeldGroupsQuery include Google::Apis::Core::Hashable - # The end date range for the search query. These timestamps are in GMT and + # The end time range for the search query. These timestamps are in GMT and # rounded down to the start of the given date. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # The start date range for the search query. These timestamps are in GMT and + # The start time range for the search query. These timestamps are in GMT and # rounded down to the start of the given date. # Corresponds to the JSON property `startTime` # @return [String] @@ -228,13 +228,13 @@ module Google class HeldMailQuery include Google::Apis::Core::Hashable - # The end date range for the search query. These timestamps are in GMT and + # The end time range for the search query. These timestamps are in GMT and # rounded down to the start of the given date. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # The start date range for the search query. These timestamps are in GMT and + # The start time range for the search query. These timestamps are in GMT and # rounded down to the start of the given date. # Corresponds to the JSON property `startTime` # @return [String] diff --git a/generated/google/apis/vault_v1/service.rb b/generated/google/apis/vault_v1/service.rb index 94eee23d2..1a9d9561a 100644 --- a/generated/google/apis/vault_v1/service.rb +++ b/generated/google/apis/vault_v1/service.rb @@ -22,7 +22,7 @@ module Google module VaultV1 # Google Vault API # - # + # Archiving and eDiscovery for G Suite. # # @example # require 'google/apis/vault_v1' @@ -30,7 +30,7 @@ module Google # Vault = Google::Apis::VaultV1 # Alias the module # service = Vault::VaultService.new # - # @see https://apps.google.com/products/vault/ + # @see https://developers.google.com/vault class VaultService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -113,7 +113,9 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new matter. Returns created matter with default view. + # Creates a new matter with the given name and description. The initial state + # is open, and the owner is the method caller. Returns the created matter + # with default view. # @param [Google::Apis::VaultV1::Matter] matter_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -212,6 +214,9 @@ module Google # Default and maximum are 100. # @param [String] page_token # The pagination token as returned in the response. + # @param [String] state + # If set, list only matters with that specific state. The default is listing + # matters of all states. # @param [String] view # Specifies which parts of the matter to return in response. # @param [String] fields @@ -231,12 +236,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_matters(page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_matters(page_size: nil, page_token: nil, state: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/matters', options) command.response_representation = Google::Apis::VaultV1::ListMattersResponse::Representation command.response_class = Google::Apis::VaultV1::ListMattersResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? + command.query['state'] = state unless state.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? diff --git a/generated/google/apis/videointelligence_v1beta1.rb b/generated/google/apis/videointelligence_v1beta1.rb index 6dc266955..aa6f1331b 100644 --- a/generated/google/apis/videointelligence_v1beta1.rb +++ b/generated/google/apis/videointelligence_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1beta1 VERSION = 'V1beta1' - REVISION = '20170919' + REVISION = '20171104' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/videointelligence_v1beta1/classes.rb b/generated/google/apis/videointelligence_v1beta1/classes.rb index 329e57461..9951d82f1 100644 --- a/generated/google/apis/videointelligence_v1beta1/classes.rb +++ b/generated/google/apis/videointelligence_v1beta1/classes.rb @@ -64,8 +64,8 @@ module Google end end - # Label annotation. - class GoogleCloudVideointelligenceV1LabelAnnotation + # Detected entity from video analysis. + class GoogleCloudVideointelligenceV1Entity include Google::Apis::Core::Hashable # Textual description, e.g. `Fixed-gear bicycle`. @@ -73,16 +73,18 @@ module Google # @return [String] attr_accessor :description + # Opaque entity ID. Some IDs may be available in + # [Google Knowledge Graph Search + # API](https://developers.google.com/knowledge-graph/). + # Corresponds to the JSON property `entityId` + # @return [String] + attr_accessor :entity_id + # Language code for `description` in BCP-47 format. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # Where the label was detected and with what confidence. - # Corresponds to the JSON property `locations` - # @return [Array] - attr_accessor :locations - def initialize(**args) update!(**args) end @@ -90,13 +92,100 @@ module Google # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) + @entity_id = args[:entity_id] if args.key?(:entity_id) @language_code = args[:language_code] if args.key?(:language_code) - @locations = args[:locations] if args.key?(:locations) end end - # Label location. - class GoogleCloudVideointelligenceV1LabelLocation + # Explicit content annotation (based on per-frame visual signals only). + # If no explicit content has been detected in a frame, no annotations are + # present for that frame. + class GoogleCloudVideointelligenceV1ExplicitContentAnnotation + include Google::Apis::Core::Hashable + + # All video frames where explicit content was detected. + # Corresponds to the JSON property `frames` + # @return [Array] + attr_accessor :frames + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @frames = args[:frames] if args.key?(:frames) + end + end + + # Video frame level annotation results for explicit content. + class GoogleCloudVideointelligenceV1ExplicitContentFrame + include Google::Apis::Core::Hashable + + # Likelihood of the pornography content.. + # Corresponds to the JSON property `pornographyLikelihood` + # @return [String] + attr_accessor :pornography_likelihood + + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this location. + # Corresponds to the JSON property `timeOffset` + # @return [String] + attr_accessor :time_offset + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @pornography_likelihood = args[:pornography_likelihood] if args.key?(:pornography_likelihood) + @time_offset = args[:time_offset] if args.key?(:time_offset) + end + end + + # Label annotation. + class GoogleCloudVideointelligenceV1LabelAnnotation + include Google::Apis::Core::Hashable + + # Common categories for the detected entity. + # E.g. when the label is `Terrier` the category is likely `dog`. And in some + # cases there might be more than one categories e.g. `Terrier` could also be + # a `pet`. + # Corresponds to the JSON property `categoryEntities` + # @return [Array] + attr_accessor :category_entities + + # Detected entity from video analysis. + # Corresponds to the JSON property `entity` + # @return [Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1Entity] + attr_accessor :entity + + # All video frames where a label was detected. + # Corresponds to the JSON property `frames` + # @return [Array] + attr_accessor :frames + + # All video segments where a label was detected. + # Corresponds to the JSON property `segments` + # @return [Array] + attr_accessor :segments + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @category_entities = args[:category_entities] if args.key?(:category_entities) + @entity = args[:entity] if args.key?(:entity) + @frames = args[:frames] if args.key?(:frames) + @segments = args[:segments] if args.key?(:segments) + end + end + + # Video frame level annotation results for label detection. + class GoogleCloudVideointelligenceV1LabelFrame include Google::Apis::Core::Hashable # Confidence that the label is accurate. Range: [0, 1]. @@ -104,10 +193,31 @@ module Google # @return [Float] attr_accessor :confidence - # Label level. - # Corresponds to the JSON property `level` + # Time-offset, relative to the beginning of the video, corresponding to the + # video frame for this location. + # Corresponds to the JSON property `timeOffset` # @return [String] - attr_accessor :level + attr_accessor :time_offset + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @confidence = args[:confidence] if args.key?(:confidence) + @time_offset = args[:time_offset] if args.key?(:time_offset) + end + end + + # Video segment level annotation results for label detection. + class GoogleCloudVideointelligenceV1LabelSegment + include Google::Apis::Core::Hashable + + # Confidence that the label is accurate. Range: [0, 1]. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence # Video segment. # Corresponds to the JSON property `segment` @@ -121,39 +231,10 @@ module Google # Update properties of this object def update!(**args) @confidence = args[:confidence] if args.key?(:confidence) - @level = args[:level] if args.key?(:level) @segment = args[:segment] if args.key?(:segment) end end - # Safe search annotation (based on per-frame visual signals only). - # If no unsafe content has been detected in a frame, no annotations - # are present for that frame. - class GoogleCloudVideointelligenceV1SafeSearchAnnotation - include Google::Apis::Core::Hashable - - # Likelihood of adult content. - # Corresponds to the JSON property `adult` - # @return [String] - attr_accessor :adult - - # Time-offset, relative to the beginning of the video, - # corresponding to the video frame for this annotation. - # Corresponds to the JSON property `time` - # @return [String] - attr_accessor :time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @adult = args[:adult] if args.key?(:adult) - @time = args[:time] if args.key?(:time) - end - end - # Annotation progress for a single video. class GoogleCloudVideointelligenceV1VideoAnnotationProgress include Google::Apis::Core::Hashable @@ -240,27 +321,42 @@ module Google # @return [Google::Apis::VideointelligenceV1beta1::GoogleRpcStatus] attr_accessor :error + # Explicit content annotation (based on per-frame visual signals only). + # If no explicit content has been detected in a frame, no annotations are + # present for that frame. + # Corresponds to the JSON property `explicitAnnotation` + # @return [Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1ExplicitContentAnnotation] + attr_accessor :explicit_annotation + + # Label annotations on frame level. + # There is exactly one element for each unique label. + # Corresponds to the JSON property `frameLabelAnnotations` + # @return [Array] + attr_accessor :frame_label_annotations + # Video file location in # [Google Cloud Storage](https://cloud.google.com/storage/). # Corresponds to the JSON property `inputUri` # @return [String] attr_accessor :input_uri - # Label annotations. There is exactly one element for each unique label. - # Corresponds to the JSON property `labelAnnotations` + # Label annotations on video level or user specified segment level. + # There is exactly one element for each unique label. + # Corresponds to the JSON property `segmentLabelAnnotations` # @return [Array] - attr_accessor :label_annotations - - # Safe search annotations. - # Corresponds to the JSON property `safeSearchAnnotations` - # @return [Array] - attr_accessor :safe_search_annotations + attr_accessor :segment_label_annotations # Shot annotations. Each shot is represented as a video segment. # Corresponds to the JSON property `shotAnnotations` # @return [Array] attr_accessor :shot_annotations + # Label annotations on shot level. + # There is exactly one element for each unique label. + # Corresponds to the JSON property `shotLabelAnnotations` + # @return [Array] + attr_accessor :shot_label_annotations + def initialize(**args) update!(**args) end @@ -268,10 +364,12 @@ module Google # Update properties of this object def update!(**args) @error = args[:error] if args.key?(:error) + @explicit_annotation = args[:explicit_annotation] if args.key?(:explicit_annotation) + @frame_label_annotations = args[:frame_label_annotations] if args.key?(:frame_label_annotations) @input_uri = args[:input_uri] if args.key?(:input_uri) - @label_annotations = args[:label_annotations] if args.key?(:label_annotations) - @safe_search_annotations = args[:safe_search_annotations] if args.key?(:safe_search_annotations) + @segment_label_annotations = args[:segment_label_annotations] if args.key?(:segment_label_annotations) @shot_annotations = args[:shot_annotations] if args.key?(:shot_annotations) + @shot_label_annotations = args[:shot_label_annotations] if args.key?(:shot_label_annotations) end end @@ -281,15 +379,15 @@ module Google # Time-offset, relative to the beginning of the video, # corresponding to the end of the segment (inclusive). - # Corresponds to the JSON property `endTime` + # Corresponds to the JSON property `endTimeOffset` # @return [String] - attr_accessor :end_time + attr_accessor :end_time_offset # Time-offset, relative to the beginning of the video, # corresponding to the start of the segment (inclusive). - # Corresponds to the JSON property `startTime` + # Corresponds to the JSON property `startTimeOffset` # @return [String] - attr_accessor :start_time + attr_accessor :start_time_offset def initialize(**args) update!(**args) @@ -297,8 +395,8 @@ module Google # Update properties of this object def update!(**args) - @end_time = args[:end_time] if args.key?(:end_time) - @start_time = args[:start_time] if args.key?(:start_time) + @end_time_offset = args[:end_time_offset] if args.key?(:end_time_offset) + @start_time_offset = args[:start_time_offset] if args.key?(:start_time_offset) end end diff --git a/generated/google/apis/videointelligence_v1beta1/representations.rb b/generated/google/apis/videointelligence_v1beta1/representations.rb index 665d88d12..09be3eb2c 100644 --- a/generated/google/apis/videointelligence_v1beta1/representations.rb +++ b/generated/google/apis/videointelligence_v1beta1/representations.rb @@ -34,19 +34,37 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1Entity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1ExplicitContentAnnotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1ExplicitContentFrame + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1LabelAnnotation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudVideointelligenceV1LabelLocation + class GoogleCloudVideointelligenceV1LabelFrame class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class GoogleCloudVideointelligenceV1SafeSearchAnnotation + class GoogleCloudVideointelligenceV1LabelSegment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -224,31 +242,59 @@ module Google end end - class GoogleCloudVideointelligenceV1LabelAnnotation + class GoogleCloudVideointelligenceV1Entity # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' + property :entity_id, as: 'entityId' property :language_code, as: 'languageCode' - collection :locations, as: 'locations', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1LabelLocation, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1LabelLocation::Representation + end + end + + class GoogleCloudVideointelligenceV1ExplicitContentAnnotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1ExplicitContentFrame, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1ExplicitContentFrame::Representation end end - class GoogleCloudVideointelligenceV1LabelLocation + class GoogleCloudVideointelligenceV1ExplicitContentFrame + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :pornography_likelihood, as: 'pornographyLikelihood' + property :time_offset, as: 'timeOffset' + end + end + + class GoogleCloudVideointelligenceV1LabelAnnotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :category_entities, as: 'categoryEntities', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1Entity, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1Entity::Representation + + property :entity, as: 'entity', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1Entity, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1Entity::Representation + + collection :frames, as: 'frames', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1LabelFrame, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1LabelFrame::Representation + + collection :segments, as: 'segments', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1LabelSegment, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1LabelSegment::Representation + + end + end + + class GoogleCloudVideointelligenceV1LabelFrame # @private class Representation < Google::Apis::Core::JsonRepresentation property :confidence, as: 'confidence' - property :level, as: 'level' - property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1VideoSegment, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1VideoSegment::Representation - + property :time_offset, as: 'timeOffset' end end - class GoogleCloudVideointelligenceV1SafeSearchAnnotation + class GoogleCloudVideointelligenceV1LabelSegment # @private class Representation < Google::Apis::Core::JsonRepresentation - property :adult, as: 'adult' - property :time, as: 'time' + property :confidence, as: 'confidence' + property :segment, as: 'segment', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1VideoSegment, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1VideoSegment::Representation + end end @@ -267,21 +313,25 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :error, as: 'error', class: Google::Apis::VideointelligenceV1beta1::GoogleRpcStatus, decorator: Google::Apis::VideointelligenceV1beta1::GoogleRpcStatus::Representation - property :input_uri, as: 'inputUri' - collection :label_annotations, as: 'labelAnnotations', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1LabelAnnotation, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1LabelAnnotation::Representation + property :explicit_annotation, as: 'explicitAnnotation', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1ExplicitContentAnnotation, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1ExplicitContentAnnotation::Representation - collection :safe_search_annotations, as: 'safeSearchAnnotations', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1SafeSearchAnnotation, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1SafeSearchAnnotation::Representation + collection :frame_label_annotations, as: 'frameLabelAnnotations', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1LabelAnnotation, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1LabelAnnotation::Representation + + property :input_uri, as: 'inputUri' + collection :segment_label_annotations, as: 'segmentLabelAnnotations', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1LabelAnnotation, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1LabelAnnotation::Representation collection :shot_annotations, as: 'shotAnnotations', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1VideoSegment, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1VideoSegment::Representation + collection :shot_label_annotations, as: 'shotLabelAnnotations', class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1LabelAnnotation, decorator: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1LabelAnnotation::Representation + end end class GoogleCloudVideointelligenceV1VideoSegment # @private class Representation < Google::Apis::Core::JsonRepresentation - property :end_time, as: 'endTime' - property :start_time, as: 'startTime' + property :end_time_offset, as: 'endTimeOffset' + property :start_time_offset, as: 'startTimeOffset' end end diff --git a/generated/google/apis/vision_v1.rb b/generated/google/apis/vision_v1.rb index d6b7dfa80..071c71cfb 100644 --- a/generated/google/apis/vision_v1.rb +++ b/generated/google/apis/vision_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/vision/ module VisionV1 VERSION = 'V1' - REVISION = '20171003' + REVISION = '20171107' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/vision_v1/classes.rb b/generated/google/apis/vision_v1/classes.rb index 78bcd4d96..cabb614ea 100644 --- a/generated/google/apis/vision_v1/classes.rb +++ b/generated/google/apis/vision_v1/classes.rb @@ -115,9 +115,9 @@ module Google # The hierarchy of an OCR extracted text structure is like this: # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please - # refer to the google.cloud.vision.v1.TextAnnotation.TextProperty message - # definition below for more detail. + # properties. Properties describe detected languages, breaks etc.. Please refer + # to the TextAnnotation.TextProperty message definition below for more + # detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1::TextAnnotation] attr_accessor :full_text_annotation @@ -732,8 +732,8 @@ module Google attr_accessor :locations # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search API](https://developers.google.com/knowledge- - # graph/). + # [Google Knowledge Graph Search + # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid @@ -1037,10 +1037,6 @@ module Google end # A face-specific landmark (for example, a face feature). - # Landmark positions may fall outside the bounds of the image - # if the face is near one or more edges of the image. - # Therefore it is NOT guaranteed that `0 <= x < width` or - # `0 <= y < height`. class Landmark include Google::Apis::Core::Hashable @@ -1072,36 +1068,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) class LatLng include Google::Apis::Core::Hashable @@ -1135,36 +1101,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # Corresponds to the JSON property `maxLatLng` # @return [Google::Apis::VisionV1::LatLng] attr_accessor :max_lat_lng @@ -1174,36 +1110,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # Corresponds to the JSON property `minLatLng` # @return [Google::Apis::VisionV1::LatLng] attr_accessor :min_lat_lng @@ -1228,36 +1134,6 @@ module Google # specified otherwise, this must conform to the # WGS84 # standard. Values must be within normalized ranges. - # Example of normalization code in Python: - # def NormalizeLongitude(longitude): - # """Wraps decimal degrees longitude to [-180.0, 180.0].""" - # q, r = divmod(longitude, 360.0) - # if r > 180.0 or (r == 180.0 and q <= -1.0): - # return r - 360.0 - # return r - # def NormalizeLatLng(latitude, longitude): - # """Wraps decimal degrees latitude and longitude to - # [-90.0, 90.0] and [-180.0, 180.0], respectively.""" - # r = latitude % 360.0 - # if r <= 90.0: - # return r, NormalizeLongitude(longitude) - # elif r >= 270.0: - # return r - 360, NormalizeLongitude(longitude) - # else: - # return 180 - r, NormalizeLongitude(longitude + 180.0) - # assert 180.0 == NormalizeLongitude(180.0) - # assert -180.0 == NormalizeLongitude(-180.0) - # assert -179.0 == NormalizeLongitude(181.0) - # assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) - # assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) - # assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) - # assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) - # assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) - # assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) - # assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) - # assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) - # assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0) # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1::LatLng] attr_accessor :lat_lng @@ -1554,9 +1430,9 @@ module Google # The hierarchy of an OCR extracted text structure is like this: # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please - # refer to the google.cloud.vision.v1.TextAnnotation.TextProperty message - # definition below for more detail. + # properties. Properties describe detected languages, breaks etc.. Please refer + # to the TextAnnotation.TextProperty message definition below for more + # detail. class TextAnnotation include Google::Apis::Core::Hashable diff --git a/generated/google/apis/vision_v1p1beta1.rb b/generated/google/apis/vision_v1p1beta1.rb new file mode 100644 index 000000000..98d8163be --- /dev/null +++ b/generated/google/apis/vision_v1p1beta1.rb @@ -0,0 +1,39 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/vision_v1p1beta1/service.rb' +require 'google/apis/vision_v1p1beta1/classes.rb' +require 'google/apis/vision_v1p1beta1/representations.rb' + +module Google + module Apis + # Google Cloud Vision API + # + # Integrates Google Vision features, including image labeling, face, logo, and + # landmark detection, optical character recognition (OCR), and detection of + # explicit content, into applications. + # + # @see https://cloud.google.com/vision/ + module VisionV1p1beta1 + VERSION = 'V1p1beta1' + REVISION = '20171107' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + + # Apply machine learning models to understand and label images + AUTH_CLOUD_VISION = 'https://www.googleapis.com/auth/cloud-vision' + end + end +end diff --git a/generated/google/apis/vision_v1p1beta1/classes.rb b/generated/google/apis/vision_v1p1beta1/classes.rb new file mode 100644 index 000000000..2a0373cc0 --- /dev/null +++ b/generated/google/apis/vision_v1p1beta1/classes.rb @@ -0,0 +1,1800 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module VisionV1p1beta1 + + # Represents a color in the RGBA color space. This representation is designed + # for simplicity of conversion to/from color representations in various + # languages over compactness; for example, the fields of this representation + # can be trivially provided to the constructor of "java.awt.Color" in Java; it + # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into + # a CSS "rgba()" string in JavaScript, as well. Here are some examples: + # Example (Java): + # import com.google.type.Color; + # // ... + # public static java.awt.Color fromProto(Color protocolor) ` + # float alpha = protocolor.hasAlpha() + # ? protocolor.getAlpha().getValue() + # : 1.0; + # return new java.awt.Color( + # protocolor.getRed(), + # protocolor.getGreen(), + # protocolor.getBlue(), + # alpha); + # ` + # public static Color toProto(java.awt.Color color) ` + # float red = (float) color.getRed(); + # float green = (float) color.getGreen(); + # float blue = (float) color.getBlue(); + # float denominator = 255.0; + # Color.Builder resultBuilder = + # Color + # .newBuilder() + # .setRed(red / denominator) + # .setGreen(green / denominator) + # .setBlue(blue / denominator); + # int alpha = color.getAlpha(); + # if (alpha != 255) ` + # result.setAlpha( + # FloatValue + # .newBuilder() + # .setValue(((float) alpha) / denominator) + # .build()); + # ` + # return resultBuilder.build(); + # ` + # // ... + # Example (iOS / Obj-C): + # // ... + # static UIColor* fromProto(Color* protocolor) ` + # float red = [protocolor red]; + # float green = [protocolor green]; + # float blue = [protocolor blue]; + # FloatValue* alpha_wrapper = [protocolor alpha]; + # float alpha = 1.0; + # if (alpha_wrapper != nil) ` + # alpha = [alpha_wrapper value]; + # ` + # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; + # ` + # static Color* toProto(UIColor* color) ` + # CGFloat red, green, blue, alpha; + # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` + # return nil; + # ` + # Color* result = [Color alloc] init]; + # [result setRed:red]; + # [result setGreen:green]; + # [result setBlue:blue]; + # if (alpha <= 0.9999) ` + # [result setAlpha:floatWrapperWithValue(alpha)]; + # ` + # [result autorelease]; + # return result; + # ` + # // ... + # Example (JavaScript): + # // ... + # var protoToCssColor = function(rgb_color) ` + # var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; + # var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); + # var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); + # if (!('alpha' in rgb_color)) ` + # return rgbToCssColor_(red, green, blue); + # ` + # var alphaFrac = rgb_color.alpha.value || 0.0; + # var rgbParams = [red, green, blue].join(','); + # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); + # `; + # var rgbToCssColor_ = function(red, green, blue) ` + # var rgbNumber = new Number((red << 16) | (green << 8) | blue); + # var hexString = rgbNumber.toString(16); + # var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; + # for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); + # ` + # resultBuilder.push(hexString); + # return resultBuilder.join(''); + # `; + # // ... + class Color + include Google::Apis::Core::Hashable + + # The fraction of this color that should be applied to the pixel. That is, + # the final pixel color is defined by the equation: + # pixel color = alpha * (this color) + (1.0 - alpha) * (background color) + # This means that a value of 1.0 corresponds to a solid color, whereas + # a value of 0.0 corresponds to a completely transparent color. This + # uses a wrapper message rather than a simple float scalar so that it is + # possible to distinguish between a default value and the value being unset. + # If omitted, this color object is to be rendered as a solid color + # (as if the alpha value had been explicitly given with a value of 1.0). + # Corresponds to the JSON property `alpha` + # @return [Float] + attr_accessor :alpha + + # The amount of blue in the color as a value in the interval [0, 1]. + # Corresponds to the JSON property `blue` + # @return [Float] + attr_accessor :blue + + # The amount of green in the color as a value in the interval [0, 1]. + # Corresponds to the JSON property `green` + # @return [Float] + attr_accessor :green + + # The amount of red in the color as a value in the interval [0, 1]. + # Corresponds to the JSON property `red` + # @return [Float] + attr_accessor :red + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @alpha = args[:alpha] if args.key?(:alpha) + @blue = args[:blue] if args.key?(:blue) + @green = args[:green] if args.key?(:green) + @red = args[:red] if args.key?(:red) + end + end + + # Request for performing Google Cloud Vision API tasks over a user-provided + # image, with user-requested features. + class GoogleCloudVisionV1p1beta1AnnotateImageRequest + include Google::Apis::Core::Hashable + + # Requested features. + # Corresponds to the JSON property `features` + # @return [Array] + attr_accessor :features + + # Client image to perform Google Cloud Vision API tasks over. + # Corresponds to the JSON property `image` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Image] + attr_accessor :image + + # Image context and/or feature-specific parameters. + # Corresponds to the JSON property `imageContext` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ImageContext] + attr_accessor :image_context + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @features = args[:features] if args.key?(:features) + @image = args[:image] if args.key?(:image) + @image_context = args[:image_context] if args.key?(:image_context) + end + end + + # Response to an image annotation request. + class GoogleCloudVisionV1p1beta1AnnotateImageResponse + include Google::Apis::Core::Hashable + + # Set of crop hints that are used to generate new crops when serving images. + # Corresponds to the JSON property `cropHintsAnnotation` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1CropHintsAnnotation] + attr_accessor :crop_hints_annotation + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by + # [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error message, + # and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + # Corresponds to the JSON property `error` + # @return [Google::Apis::VisionV1p1beta1::Status] + attr_accessor :error + + # If present, face detection has completed successfully. + # Corresponds to the JSON property `faceAnnotations` + # @return [Array] + attr_accessor :face_annotations + + # TextAnnotation contains a structured representation of OCR extracted text. + # The hierarchy of an OCR extracted text structure is like this: + # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol + # Each structural component, starting from Page, may further have their own + # properties. Properties describe detected languages, breaks etc.. Please refer + # to the TextAnnotation.TextProperty message definition below for more + # detail. + # Corresponds to the JSON property `fullTextAnnotation` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotation] + attr_accessor :full_text_annotation + + # Stores image properties, such as dominant colors. + # Corresponds to the JSON property `imagePropertiesAnnotation` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ImageProperties] + attr_accessor :image_properties_annotation + + # If present, label detection has completed successfully. + # Corresponds to the JSON property `labelAnnotations` + # @return [Array] + attr_accessor :label_annotations + + # If present, landmark detection has completed successfully. + # Corresponds to the JSON property `landmarkAnnotations` + # @return [Array] + attr_accessor :landmark_annotations + + # If present, logo detection has completed successfully. + # Corresponds to the JSON property `logoAnnotations` + # @return [Array] + attr_accessor :logo_annotations + + # Set of features pertaining to the image, computed by computer vision + # methods over safe-search verticals (for example, adult, spoof, medical, + # violence). + # Corresponds to the JSON property `safeSearchAnnotation` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1SafeSearchAnnotation] + attr_accessor :safe_search_annotation + + # If present, text (OCR) detection has completed successfully. + # Corresponds to the JSON property `textAnnotations` + # @return [Array] + attr_accessor :text_annotations + + # Relevant information for the image from the Internet. + # Corresponds to the JSON property `webDetection` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetection] + attr_accessor :web_detection + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @crop_hints_annotation = args[:crop_hints_annotation] if args.key?(:crop_hints_annotation) + @error = args[:error] if args.key?(:error) + @face_annotations = args[:face_annotations] if args.key?(:face_annotations) + @full_text_annotation = args[:full_text_annotation] if args.key?(:full_text_annotation) + @image_properties_annotation = args[:image_properties_annotation] if args.key?(:image_properties_annotation) + @label_annotations = args[:label_annotations] if args.key?(:label_annotations) + @landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations) + @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations) + @safe_search_annotation = args[:safe_search_annotation] if args.key?(:safe_search_annotation) + @text_annotations = args[:text_annotations] if args.key?(:text_annotations) + @web_detection = args[:web_detection] if args.key?(:web_detection) + end + end + + # Multiple image annotation requests are batched into a single service call. + class GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest + include Google::Apis::Core::Hashable + + # Individual image annotation requests for this batch. + # Corresponds to the JSON property `requests` + # @return [Array] + attr_accessor :requests + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @requests = args[:requests] if args.key?(:requests) + end + end + + # Response to a batch image annotation request. + class GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse + include Google::Apis::Core::Hashable + + # Individual responses to image annotation requests within the batch. + # Corresponds to the JSON property `responses` + # @return [Array] + attr_accessor :responses + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @responses = args[:responses] if args.key?(:responses) + end + end + + # Logical element on the page. + class GoogleCloudVisionV1p1beta1Block + include Google::Apis::Core::Hashable + + # Detected block type (text, image etc) for this block. + # Corresponds to the JSON property `blockType` + # @return [String] + attr_accessor :block_type + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingBox` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly] + attr_accessor :bounding_box + + # Confidence of the OCR results on the block. Range [0, 1]. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # List of paragraphs in this block (if this blocks is of type text). + # Corresponds to the JSON property `paragraphs` + # @return [Array] + attr_accessor :paragraphs + + # Additional information detected on the structural component. + # Corresponds to the JSON property `property` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty] + attr_accessor :property + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @block_type = args[:block_type] if args.key?(:block_type) + @bounding_box = args[:bounding_box] if args.key?(:bounding_box) + @confidence = args[:confidence] if args.key?(:confidence) + @paragraphs = args[:paragraphs] if args.key?(:paragraphs) + @property = args[:property] if args.key?(:property) + end + end + + # A bounding polygon for the detected image annotation. + class GoogleCloudVisionV1p1beta1BoundingPoly + include Google::Apis::Core::Hashable + + # The bounding polygon vertices. + # Corresponds to the JSON property `vertices` + # @return [Array] + attr_accessor :vertices + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @vertices = args[:vertices] if args.key?(:vertices) + end + end + + # Color information consists of RGB channels, score, and the fraction of + # the image that the color occupies in the image. + class GoogleCloudVisionV1p1beta1ColorInfo + include Google::Apis::Core::Hashable + + # Represents a color in the RGBA color space. This representation is designed + # for simplicity of conversion to/from color representations in various + # languages over compactness; for example, the fields of this representation + # can be trivially provided to the constructor of "java.awt.Color" in Java; it + # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into + # a CSS "rgba()" string in JavaScript, as well. Here are some examples: + # Example (Java): + # import com.google.type.Color; + # // ... + # public static java.awt.Color fromProto(Color protocolor) ` + # float alpha = protocolor.hasAlpha() + # ? protocolor.getAlpha().getValue() + # : 1.0; + # return new java.awt.Color( + # protocolor.getRed(), + # protocolor.getGreen(), + # protocolor.getBlue(), + # alpha); + # ` + # public static Color toProto(java.awt.Color color) ` + # float red = (float) color.getRed(); + # float green = (float) color.getGreen(); + # float blue = (float) color.getBlue(); + # float denominator = 255.0; + # Color.Builder resultBuilder = + # Color + # .newBuilder() + # .setRed(red / denominator) + # .setGreen(green / denominator) + # .setBlue(blue / denominator); + # int alpha = color.getAlpha(); + # if (alpha != 255) ` + # result.setAlpha( + # FloatValue + # .newBuilder() + # .setValue(((float) alpha) / denominator) + # .build()); + # ` + # return resultBuilder.build(); + # ` + # // ... + # Example (iOS / Obj-C): + # // ... + # static UIColor* fromProto(Color* protocolor) ` + # float red = [protocolor red]; + # float green = [protocolor green]; + # float blue = [protocolor blue]; + # FloatValue* alpha_wrapper = [protocolor alpha]; + # float alpha = 1.0; + # if (alpha_wrapper != nil) ` + # alpha = [alpha_wrapper value]; + # ` + # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; + # ` + # static Color* toProto(UIColor* color) ` + # CGFloat red, green, blue, alpha; + # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` + # return nil; + # ` + # Color* result = [Color alloc] init]; + # [result setRed:red]; + # [result setGreen:green]; + # [result setBlue:blue]; + # if (alpha <= 0.9999) ` + # [result setAlpha:floatWrapperWithValue(alpha)]; + # ` + # [result autorelease]; + # return result; + # ` + # // ... + # Example (JavaScript): + # // ... + # var protoToCssColor = function(rgb_color) ` + # var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; + # var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); + # var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); + # if (!('alpha' in rgb_color)) ` + # return rgbToCssColor_(red, green, blue); + # ` + # var alphaFrac = rgb_color.alpha.value || 0.0; + # var rgbParams = [red, green, blue].join(','); + # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); + # `; + # var rgbToCssColor_ = function(red, green, blue) ` + # var rgbNumber = new Number((red << 16) | (green << 8) | blue); + # var hexString = rgbNumber.toString(16); + # var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; + # for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); + # ` + # resultBuilder.push(hexString); + # return resultBuilder.join(''); + # `; + # // ... + # Corresponds to the JSON property `color` + # @return [Google::Apis::VisionV1p1beta1::Color] + attr_accessor :color + + # The fraction of pixels the color occupies in the image. + # Value in range [0, 1]. + # Corresponds to the JSON property `pixelFraction` + # @return [Float] + attr_accessor :pixel_fraction + + # Image-specific score for this color. Value in range [0, 1]. + # Corresponds to the JSON property `score` + # @return [Float] + attr_accessor :score + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @color = args[:color] if args.key?(:color) + @pixel_fraction = args[:pixel_fraction] if args.key?(:pixel_fraction) + @score = args[:score] if args.key?(:score) + end + end + + # Single crop hint that is used to generate a new crop when serving an image. + class GoogleCloudVisionV1p1beta1CropHint + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly] + attr_accessor :bounding_poly + + # Confidence of this being a salient region. Range [0, 1]. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Fraction of importance of this salient region with respect to the original + # image. + # Corresponds to the JSON property `importanceFraction` + # @return [Float] + attr_accessor :importance_fraction + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @confidence = args[:confidence] if args.key?(:confidence) + @importance_fraction = args[:importance_fraction] if args.key?(:importance_fraction) + end + end + + # Set of crop hints that are used to generate new crops when serving images. + class GoogleCloudVisionV1p1beta1CropHintsAnnotation + include Google::Apis::Core::Hashable + + # Crop hint results. + # Corresponds to the JSON property `cropHints` + # @return [Array] + attr_accessor :crop_hints + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @crop_hints = args[:crop_hints] if args.key?(:crop_hints) + end + end + + # Parameters for crop hints annotation request. + class GoogleCloudVisionV1p1beta1CropHintsParams + include Google::Apis::Core::Hashable + + # Aspect ratios in floats, representing the ratio of the width to the height + # of the image. For example, if the desired aspect ratio is 4/3, the + # corresponding float value should be 1.33333. If not specified, the + # best possible crop is returned. The number of provided aspect ratios is + # limited to a maximum of 16; any aspect ratios provided after the 16th are + # ignored. + # Corresponds to the JSON property `aspectRatios` + # @return [Array] + attr_accessor :aspect_ratios + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @aspect_ratios = args[:aspect_ratios] if args.key?(:aspect_ratios) + end + end + + # Set of dominant colors and their corresponding scores. + class GoogleCloudVisionV1p1beta1DominantColorsAnnotation + include Google::Apis::Core::Hashable + + # RGB color values with their score and pixel fraction. + # Corresponds to the JSON property `colors` + # @return [Array] + attr_accessor :colors + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @colors = args[:colors] if args.key?(:colors) + end + end + + # Set of detected entity features. + class GoogleCloudVisionV1p1beta1EntityAnnotation + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly] + attr_accessor :bounding_poly + + # The accuracy of the entity detection in an image. + # For example, for an image in which the "Eiffel Tower" entity is detected, + # this field represents the confidence that there is a tower in the query + # image. Range [0, 1]. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Entity textual description, expressed in its `locale` language. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The language code for the locale in which the entity textual + # `description` is expressed. + # Corresponds to the JSON property `locale` + # @return [String] + attr_accessor :locale + + # The location information for the detected entity. Multiple + # `LocationInfo` elements can be present because one location may + # indicate the location of the scene in the image, and another location + # may indicate the location of the place where the image was taken. + # Location information is usually present for landmarks. + # Corresponds to the JSON property `locations` + # @return [Array] + attr_accessor :locations + + # Opaque entity ID. Some IDs may be available in + # [Google Knowledge Graph Search + # API](https://developers.google.com/knowledge-graph/). + # Corresponds to the JSON property `mid` + # @return [String] + attr_accessor :mid + + # Some entities may have optional user-supplied `Property` (name/value) + # fields, such a score or string that qualifies the entity. + # Corresponds to the JSON property `properties` + # @return [Array] + attr_accessor :properties + + # Overall score of the result. Range [0, 1]. + # Corresponds to the JSON property `score` + # @return [Float] + attr_accessor :score + + # The relevancy of the ICA (Image Content Annotation) label to the + # image. For example, the relevancy of "tower" is likely higher to an image + # containing the detected "Eiffel Tower" than to an image containing a + # detected distant towering building, even though the confidence that + # there is a tower in each image may be the same. Range [0, 1]. + # Corresponds to the JSON property `topicality` + # @return [Float] + attr_accessor :topicality + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @confidence = args[:confidence] if args.key?(:confidence) + @description = args[:description] if args.key?(:description) + @locale = args[:locale] if args.key?(:locale) + @locations = args[:locations] if args.key?(:locations) + @mid = args[:mid] if args.key?(:mid) + @properties = args[:properties] if args.key?(:properties) + @score = args[:score] if args.key?(:score) + @topicality = args[:topicality] if args.key?(:topicality) + end + end + + # A face annotation object contains the results of face detection. + class GoogleCloudVisionV1p1beta1FaceAnnotation + include Google::Apis::Core::Hashable + + # Anger likelihood. + # Corresponds to the JSON property `angerLikelihood` + # @return [String] + attr_accessor :anger_likelihood + + # Blurred likelihood. + # Corresponds to the JSON property `blurredLikelihood` + # @return [String] + attr_accessor :blurred_likelihood + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly] + attr_accessor :bounding_poly + + # Detection confidence. Range [0, 1]. + # Corresponds to the JSON property `detectionConfidence` + # @return [Float] + attr_accessor :detection_confidence + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `fdBoundingPoly` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly] + attr_accessor :fd_bounding_poly + + # Headwear likelihood. + # Corresponds to the JSON property `headwearLikelihood` + # @return [String] + attr_accessor :headwear_likelihood + + # Joy likelihood. + # Corresponds to the JSON property `joyLikelihood` + # @return [String] + attr_accessor :joy_likelihood + + # Face landmarking confidence. Range [0, 1]. + # Corresponds to the JSON property `landmarkingConfidence` + # @return [Float] + attr_accessor :landmarking_confidence + + # Detected face landmarks. + # Corresponds to the JSON property `landmarks` + # @return [Array] + attr_accessor :landmarks + + # Yaw angle, which indicates the leftward/rightward angle that the face is + # pointing relative to the vertical plane perpendicular to the image. Range + # [-180,180]. + # Corresponds to the JSON property `panAngle` + # @return [Float] + attr_accessor :pan_angle + + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation + # of the face relative to the image vertical about the axis perpendicular to + # the face. Range [-180,180]. + # Corresponds to the JSON property `rollAngle` + # @return [Float] + attr_accessor :roll_angle + + # Sorrow likelihood. + # Corresponds to the JSON property `sorrowLikelihood` + # @return [String] + attr_accessor :sorrow_likelihood + + # Surprise likelihood. + # Corresponds to the JSON property `surpriseLikelihood` + # @return [String] + attr_accessor :surprise_likelihood + + # Pitch angle, which indicates the upwards/downwards angle that the face is + # pointing relative to the image's horizontal plane. Range [-180,180]. + # Corresponds to the JSON property `tiltAngle` + # @return [Float] + attr_accessor :tilt_angle + + # Under-exposed likelihood. + # Corresponds to the JSON property `underExposedLikelihood` + # @return [String] + attr_accessor :under_exposed_likelihood + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @anger_likelihood = args[:anger_likelihood] if args.key?(:anger_likelihood) + @blurred_likelihood = args[:blurred_likelihood] if args.key?(:blurred_likelihood) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @detection_confidence = args[:detection_confidence] if args.key?(:detection_confidence) + @fd_bounding_poly = args[:fd_bounding_poly] if args.key?(:fd_bounding_poly) + @headwear_likelihood = args[:headwear_likelihood] if args.key?(:headwear_likelihood) + @joy_likelihood = args[:joy_likelihood] if args.key?(:joy_likelihood) + @landmarking_confidence = args[:landmarking_confidence] if args.key?(:landmarking_confidence) + @landmarks = args[:landmarks] if args.key?(:landmarks) + @pan_angle = args[:pan_angle] if args.key?(:pan_angle) + @roll_angle = args[:roll_angle] if args.key?(:roll_angle) + @sorrow_likelihood = args[:sorrow_likelihood] if args.key?(:sorrow_likelihood) + @surprise_likelihood = args[:surprise_likelihood] if args.key?(:surprise_likelihood) + @tilt_angle = args[:tilt_angle] if args.key?(:tilt_angle) + @under_exposed_likelihood = args[:under_exposed_likelihood] if args.key?(:under_exposed_likelihood) + end + end + + # A face-specific landmark (for example, a face feature). + class GoogleCloudVisionV1p1beta1FaceAnnotationLandmark + include Google::Apis::Core::Hashable + + # A 3D position in the image, used primarily for Face detection landmarks. + # A valid Position must have both x and y coordinates. + # The position coordinates are in the same scale as the original image. + # Corresponds to the JSON property `position` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Position] + attr_accessor :position + + # Face landmark type. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @position = args[:position] if args.key?(:position) + @type = args[:type] if args.key?(:type) + end + end + + # Users describe the type of Google Cloud Vision API tasks to perform over + # images by using *Feature*s. Each Feature indicates a type of image + # detection task to perform. Features encode the Cloud Vision API + # vertical to operate on and the number of top-scoring results to return. + class GoogleCloudVisionV1p1beta1Feature + include Google::Apis::Core::Hashable + + # Maximum number of results of this type. + # Corresponds to the JSON property `maxResults` + # @return [Fixnum] + attr_accessor :max_results + + # Model to use for the feature. + # Supported values: "builtin/stable" (the default if unset) and + # "builtin/latest". + # Corresponds to the JSON property `model` + # @return [String] + attr_accessor :model + + # The feature type. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @max_results = args[:max_results] if args.key?(:max_results) + @model = args[:model] if args.key?(:model) + @type = args[:type] if args.key?(:type) + end + end + + # Client image to perform Google Cloud Vision API tasks over. + class GoogleCloudVisionV1p1beta1Image + include Google::Apis::Core::Hashable + + # Image content, represented as a stream of bytes. + # Note: as with all `bytes` fields, protobuffers use a pure binary + # representation, whereas JSON representations use base64. + # Corresponds to the JSON property `content` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :content + + # External image source (Google Cloud Storage image location). + # Corresponds to the JSON property `source` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ImageSource] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content = args[:content] if args.key?(:content) + @source = args[:source] if args.key?(:source) + end + end + + # Image context and/or feature-specific parameters. + class GoogleCloudVisionV1p1beta1ImageContext + include Google::Apis::Core::Hashable + + # Parameters for crop hints annotation request. + # Corresponds to the JSON property `cropHintsParams` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1CropHintsParams] + attr_accessor :crop_hints_params + + # List of languages to use for TEXT_DETECTION. In most cases, an empty value + # yields the best results since it enables automatic language detection. For + # languages based on the Latin alphabet, setting `language_hints` is not + # needed. In rare cases, when the language of the text in the image is known, + # setting a hint will help get better results (although it will be a + # significant hindrance if the hint is wrong). Text detection returns an + # error if one or more of the specified languages is not one of the + # [supported languages](/vision/docs/languages). + # Corresponds to the JSON property `languageHints` + # @return [Array] + attr_accessor :language_hints + + # Rectangle determined by min and max `LatLng` pairs. + # Corresponds to the JSON property `latLongRect` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1LatLongRect] + attr_accessor :lat_long_rect + + # Parameters for web detection request. + # Corresponds to the JSON property `webDetectionParams` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionParams] + attr_accessor :web_detection_params + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @crop_hints_params = args[:crop_hints_params] if args.key?(:crop_hints_params) + @language_hints = args[:language_hints] if args.key?(:language_hints) + @lat_long_rect = args[:lat_long_rect] if args.key?(:lat_long_rect) + @web_detection_params = args[:web_detection_params] if args.key?(:web_detection_params) + end + end + + # Stores image properties, such as dominant colors. + class GoogleCloudVisionV1p1beta1ImageProperties + include Google::Apis::Core::Hashable + + # Set of dominant colors and their corresponding scores. + # Corresponds to the JSON property `dominantColors` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1DominantColorsAnnotation] + attr_accessor :dominant_colors + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dominant_colors = args[:dominant_colors] if args.key?(:dominant_colors) + end + end + + # External image source (Google Cloud Storage image location). + class GoogleCloudVisionV1p1beta1ImageSource + include Google::Apis::Core::Hashable + + # NOTE: For new code `image_uri` below is preferred. + # Google Cloud Storage image URI, which must be in the following form: + # `gs://bucket_name/object_name` (for details, see + # [Google Cloud Storage Request + # URIs](https://cloud.google.com/storage/docs/reference-uris)). + # NOTE: Cloud Storage object versioning is not supported. + # Corresponds to the JSON property `gcsImageUri` + # @return [String] + attr_accessor :gcs_image_uri + + # Image URI which supports: + # 1) Google Cloud Storage image URI, which must be in the following form: + # `gs://bucket_name/object_name` (for details, see + # [Google Cloud Storage Request + # URIs](https://cloud.google.com/storage/docs/reference-uris)). + # NOTE: Cloud Storage object versioning is not supported. + # 2) Publicly accessible image HTTP/HTTPS URL. + # This is preferred over the legacy `gcs_image_uri` above. When both + # `gcs_image_uri` and `image_uri` are specified, `image_uri` takes + # precedence. + # Corresponds to the JSON property `imageUri` + # @return [String] + attr_accessor :image_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gcs_image_uri = args[:gcs_image_uri] if args.key?(:gcs_image_uri) + @image_uri = args[:image_uri] if args.key?(:image_uri) + end + end + + # Rectangle determined by min and max `LatLng` pairs. + class GoogleCloudVisionV1p1beta1LatLongRect + include Google::Apis::Core::Hashable + + # An object representing a latitude/longitude pair. This is expressed as a pair + # of doubles representing degrees latitude and degrees longitude. Unless + # specified otherwise, this must conform to the + # WGS84 + # standard. Values must be within normalized ranges. + # Corresponds to the JSON property `maxLatLng` + # @return [Google::Apis::VisionV1p1beta1::LatLng] + attr_accessor :max_lat_lng + + # An object representing a latitude/longitude pair. This is expressed as a pair + # of doubles representing degrees latitude and degrees longitude. Unless + # specified otherwise, this must conform to the + # WGS84 + # standard. Values must be within normalized ranges. + # Corresponds to the JSON property `minLatLng` + # @return [Google::Apis::VisionV1p1beta1::LatLng] + attr_accessor :min_lat_lng + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @max_lat_lng = args[:max_lat_lng] if args.key?(:max_lat_lng) + @min_lat_lng = args[:min_lat_lng] if args.key?(:min_lat_lng) + end + end + + # Detected entity location information. + class GoogleCloudVisionV1p1beta1LocationInfo + include Google::Apis::Core::Hashable + + # An object representing a latitude/longitude pair. This is expressed as a pair + # of doubles representing degrees latitude and degrees longitude. Unless + # specified otherwise, this must conform to the + # WGS84 + # standard. Values must be within normalized ranges. + # Corresponds to the JSON property `latLng` + # @return [Google::Apis::VisionV1p1beta1::LatLng] + attr_accessor :lat_lng + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @lat_lng = args[:lat_lng] if args.key?(:lat_lng) + end + end + + # Detected page from OCR. + class GoogleCloudVisionV1p1beta1Page + include Google::Apis::Core::Hashable + + # List of blocks of text, images etc on this page. + # Corresponds to the JSON property `blocks` + # @return [Array] + attr_accessor :blocks + + # Confidence of the OCR results on the page. Range [0, 1]. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Page height in pixels. + # Corresponds to the JSON property `height` + # @return [Fixnum] + attr_accessor :height + + # Additional information detected on the structural component. + # Corresponds to the JSON property `property` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty] + attr_accessor :property + + # Page width in pixels. + # Corresponds to the JSON property `width` + # @return [Fixnum] + attr_accessor :width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @blocks = args[:blocks] if args.key?(:blocks) + @confidence = args[:confidence] if args.key?(:confidence) + @height = args[:height] if args.key?(:height) + @property = args[:property] if args.key?(:property) + @width = args[:width] if args.key?(:width) + end + end + + # Structural unit of text representing a number of words in certain order. + class GoogleCloudVisionV1p1beta1Paragraph + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingBox` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly] + attr_accessor :bounding_box + + # Confidence of the OCR results for the paragraph. Range [0, 1]. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Additional information detected on the structural component. + # Corresponds to the JSON property `property` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty] + attr_accessor :property + + # List of words in this paragraph. + # Corresponds to the JSON property `words` + # @return [Array] + attr_accessor :words + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_box = args[:bounding_box] if args.key?(:bounding_box) + @confidence = args[:confidence] if args.key?(:confidence) + @property = args[:property] if args.key?(:property) + @words = args[:words] if args.key?(:words) + end + end + + # A 3D position in the image, used primarily for Face detection landmarks. + # A valid Position must have both x and y coordinates. + # The position coordinates are in the same scale as the original image. + class GoogleCloudVisionV1p1beta1Position + include Google::Apis::Core::Hashable + + # X coordinate. + # Corresponds to the JSON property `x` + # @return [Float] + attr_accessor :x + + # Y coordinate. + # Corresponds to the JSON property `y` + # @return [Float] + attr_accessor :y + + # Z coordinate (or depth). + # Corresponds to the JSON property `z` + # @return [Float] + attr_accessor :z + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @x = args[:x] if args.key?(:x) + @y = args[:y] if args.key?(:y) + @z = args[:z] if args.key?(:z) + end + end + + # A `Property` consists of a user-supplied name/value pair. + class GoogleCloudVisionV1p1beta1Property + include Google::Apis::Core::Hashable + + # Name of the property. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Value of numeric properties. + # Corresponds to the JSON property `uint64Value` + # @return [Fixnum] + attr_accessor :uint64_value + + # Value of the property. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @uint64_value = args[:uint64_value] if args.key?(:uint64_value) + @value = args[:value] if args.key?(:value) + end + end + + # Set of features pertaining to the image, computed by computer vision + # methods over safe-search verticals (for example, adult, spoof, medical, + # violence). + class GoogleCloudVisionV1p1beta1SafeSearchAnnotation + include Google::Apis::Core::Hashable + + # Represents the adult content likelihood for the image. Adult content may + # contain elements such as nudity, pornographic images or cartoons, or + # sexual activities. + # Corresponds to the JSON property `adult` + # @return [String] + attr_accessor :adult + + # Likelihood that this is a medical image. + # Corresponds to the JSON property `medical` + # @return [String] + attr_accessor :medical + + # Likelihood that the request image contains racy content. Racy content may + # include (but is not limited to) skimpy or sheer clothing, strategically + # covered nudity, lewd or provocative poses, or close-ups of sensitive + # body areas. + # Corresponds to the JSON property `racy` + # @return [String] + attr_accessor :racy + + # Spoof likelihood. The likelihood that an modification + # was made to the image's canonical version to make it appear + # funny or offensive. + # Corresponds to the JSON property `spoof` + # @return [String] + attr_accessor :spoof + + # Likelihood that this image contains violent content. + # Corresponds to the JSON property `violence` + # @return [String] + attr_accessor :violence + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @adult = args[:adult] if args.key?(:adult) + @medical = args[:medical] if args.key?(:medical) + @racy = args[:racy] if args.key?(:racy) + @spoof = args[:spoof] if args.key?(:spoof) + @violence = args[:violence] if args.key?(:violence) + end + end + + # A single symbol representation. + class GoogleCloudVisionV1p1beta1Symbol + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingBox` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly] + attr_accessor :bounding_box + + # Confidence of the OCR results for the symbol. Range [0, 1]. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Additional information detected on the structural component. + # Corresponds to the JSON property `property` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty] + attr_accessor :property + + # The actual UTF-8 representation of the symbol. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_box = args[:bounding_box] if args.key?(:bounding_box) + @confidence = args[:confidence] if args.key?(:confidence) + @property = args[:property] if args.key?(:property) + @text = args[:text] if args.key?(:text) + end + end + + # TextAnnotation contains a structured representation of OCR extracted text. + # The hierarchy of an OCR extracted text structure is like this: + # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol + # Each structural component, starting from Page, may further have their own + # properties. Properties describe detected languages, breaks etc.. Please refer + # to the TextAnnotation.TextProperty message definition below for more + # detail. + class GoogleCloudVisionV1p1beta1TextAnnotation + include Google::Apis::Core::Hashable + + # List of pages detected by OCR. + # Corresponds to the JSON property `pages` + # @return [Array] + attr_accessor :pages + + # UTF-8 text detected on the pages. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @pages = args[:pages] if args.key?(:pages) + @text = args[:text] if args.key?(:text) + end + end + + # Detected start or end of a structural component. + class GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak + include Google::Apis::Core::Hashable + + # True if break prepends the element. + # Corresponds to the JSON property `isPrefix` + # @return [Boolean] + attr_accessor :is_prefix + alias_method :is_prefix?, :is_prefix + + # Detected break type. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @is_prefix = args[:is_prefix] if args.key?(:is_prefix) + @type = args[:type] if args.key?(:type) + end + end + + # Detected language for a structural component. + class GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage + include Google::Apis::Core::Hashable + + # Confidence of detected language. Range [0, 1]. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more + # information, see + # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @confidence = args[:confidence] if args.key?(:confidence) + @language_code = args[:language_code] if args.key?(:language_code) + end + end + + # Additional information detected on the structural component. + class GoogleCloudVisionV1p1beta1TextAnnotationTextProperty + include Google::Apis::Core::Hashable + + # Detected start or end of a structural component. + # Corresponds to the JSON property `detectedBreak` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak] + attr_accessor :detected_break + + # A list of detected languages together with confidence. + # Corresponds to the JSON property `detectedLanguages` + # @return [Array] + attr_accessor :detected_languages + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @detected_break = args[:detected_break] if args.key?(:detected_break) + @detected_languages = args[:detected_languages] if args.key?(:detected_languages) + end + end + + # A vertex represents a 2D point in the image. + # NOTE: the vertex coordinates are in the same scale as the original image. + class GoogleCloudVisionV1p1beta1Vertex + include Google::Apis::Core::Hashable + + # X coordinate. + # Corresponds to the JSON property `x` + # @return [Fixnum] + attr_accessor :x + + # Y coordinate. + # Corresponds to the JSON property `y` + # @return [Fixnum] + attr_accessor :y + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @x = args[:x] if args.key?(:x) + @y = args[:y] if args.key?(:y) + end + end + + # Relevant information for the image from the Internet. + class GoogleCloudVisionV1p1beta1WebDetection + include Google::Apis::Core::Hashable + + # Best guess text labels for the request image. + # Corresponds to the JSON property `bestGuessLabels` + # @return [Array] + attr_accessor :best_guess_labels + + # Fully matching images from the Internet. + # Can include resized copies of the query image. + # Corresponds to the JSON property `fullMatchingImages` + # @return [Array] + attr_accessor :full_matching_images + + # Web pages containing the matching images from the Internet. + # Corresponds to the JSON property `pagesWithMatchingImages` + # @return [Array] + attr_accessor :pages_with_matching_images + + # Partial matching images from the Internet. + # Those images are similar enough to share some key-point features. For + # example an original image will likely have partial matching for its crops. + # Corresponds to the JSON property `partialMatchingImages` + # @return [Array] + attr_accessor :partial_matching_images + + # The visually similar image results. + # Corresponds to the JSON property `visuallySimilarImages` + # @return [Array] + attr_accessor :visually_similar_images + + # Deduced entities from similar images on the Internet. + # Corresponds to the JSON property `webEntities` + # @return [Array] + attr_accessor :web_entities + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @best_guess_labels = args[:best_guess_labels] if args.key?(:best_guess_labels) + @full_matching_images = args[:full_matching_images] if args.key?(:full_matching_images) + @pages_with_matching_images = args[:pages_with_matching_images] if args.key?(:pages_with_matching_images) + @partial_matching_images = args[:partial_matching_images] if args.key?(:partial_matching_images) + @visually_similar_images = args[:visually_similar_images] if args.key?(:visually_similar_images) + @web_entities = args[:web_entities] if args.key?(:web_entities) + end + end + + # Parameters for web detection request. + class GoogleCloudVisionV1p1beta1WebDetectionParams + include Google::Apis::Core::Hashable + + # Whether to include results derived from the geo information in the image. + # Corresponds to the JSON property `includeGeoResults` + # @return [Boolean] + attr_accessor :include_geo_results + alias_method :include_geo_results?, :include_geo_results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @include_geo_results = args[:include_geo_results] if args.key?(:include_geo_results) + end + end + + # Entity deduced from similar images on the Internet. + class GoogleCloudVisionV1p1beta1WebDetectionWebEntity + include Google::Apis::Core::Hashable + + # Canonical description of the entity, in English. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Opaque entity ID. + # Corresponds to the JSON property `entityId` + # @return [String] + attr_accessor :entity_id + + # Overall relevancy score for the entity. + # Not normalized and not comparable across different image queries. + # Corresponds to the JSON property `score` + # @return [Float] + attr_accessor :score + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @entity_id = args[:entity_id] if args.key?(:entity_id) + @score = args[:score] if args.key?(:score) + end + end + + # Metadata for online images. + class GoogleCloudVisionV1p1beta1WebDetectionWebImage + include Google::Apis::Core::Hashable + + # (Deprecated) Overall relevancy score for the image. + # Corresponds to the JSON property `score` + # @return [Float] + attr_accessor :score + + # The result image URL. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @score = args[:score] if args.key?(:score) + @url = args[:url] if args.key?(:url) + end + end + + # Label to provide extra metadata for the web detection. + class GoogleCloudVisionV1p1beta1WebDetectionWebLabel + include Google::Apis::Core::Hashable + + # Label for extra metadata. + # Corresponds to the JSON property `label` + # @return [String] + attr_accessor :label + + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". + # For more information, see + # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @label = args[:label] if args.key?(:label) + @language_code = args[:language_code] if args.key?(:language_code) + end + end + + # Metadata for web pages. + class GoogleCloudVisionV1p1beta1WebDetectionWebPage + include Google::Apis::Core::Hashable + + # Fully matching images on the page. + # Can include resized copies of the query image. + # Corresponds to the JSON property `fullMatchingImages` + # @return [Array] + attr_accessor :full_matching_images + + # Title for the web page, may contain HTML markups. + # Corresponds to the JSON property `pageTitle` + # @return [String] + attr_accessor :page_title + + # Partial matching images on the page. + # Those images are similar enough to share some key-point features. For + # example an original image will likely have partial matching for its + # crops. + # Corresponds to the JSON property `partialMatchingImages` + # @return [Array] + attr_accessor :partial_matching_images + + # (Deprecated) Overall relevancy score for the web page. + # Corresponds to the JSON property `score` + # @return [Float] + attr_accessor :score + + # The result web page URL. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @full_matching_images = args[:full_matching_images] if args.key?(:full_matching_images) + @page_title = args[:page_title] if args.key?(:page_title) + @partial_matching_images = args[:partial_matching_images] if args.key?(:partial_matching_images) + @score = args[:score] if args.key?(:score) + @url = args[:url] if args.key?(:url) + end + end + + # A word representation. + class GoogleCloudVisionV1p1beta1Word + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingBox` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly] + attr_accessor :bounding_box + + # Confidence of the OCR results for the word. Range [0, 1]. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Additional information detected on the structural component. + # Corresponds to the JSON property `property` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty] + attr_accessor :property + + # List of symbols in the word. + # The order of the symbols follows the natural reading order. + # Corresponds to the JSON property `symbols` + # @return [Array] + attr_accessor :symbols + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_box = args[:bounding_box] if args.key?(:bounding_box) + @confidence = args[:confidence] if args.key?(:confidence) + @property = args[:property] if args.key?(:property) + @symbols = args[:symbols] if args.key?(:symbols) + end + end + + # An object representing a latitude/longitude pair. This is expressed as a pair + # of doubles representing degrees latitude and degrees longitude. Unless + # specified otherwise, this must conform to the + # WGS84 + # standard. Values must be within normalized ranges. + class LatLng + include Google::Apis::Core::Hashable + + # The latitude in degrees. It must be in the range [-90.0, +90.0]. + # Corresponds to the JSON property `latitude` + # @return [Float] + attr_accessor :latitude + + # The longitude in degrees. It must be in the range [-180.0, +180.0]. + # Corresponds to the JSON property `longitude` + # @return [Float] + attr_accessor :longitude + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @latitude = args[:latitude] if args.key?(:latitude) + @longitude = args[:longitude] if args.key?(:longitude) + end + end + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by + # [gRPC](https://github.com/grpc). The error model is designed to be: + # - Simple to use and understand for most users + # - Flexible enough to meet unexpected needs + # # Overview + # The `Status` message contains three pieces of data: error code, error message, + # and error details. The error code should be an enum value of + # google.rpc.Code, but it may accept additional error codes if needed. The + # error message should be a developer-facing English message that helps + # developers *understand* and *resolve* the error. If a localized user-facing + # error message is needed, put the localized message in the error details or + # localize it in the client. The optional error details may contain arbitrary + # information about the error. There is a predefined set of error detail types + # in the package `google.rpc` that can be used for common error conditions. + # # Language mapping + # The `Status` message is the logical representation of the error model, but it + # is not necessarily the actual wire format. When the `Status` message is + # exposed in different client libraries and different wire protocols, it can be + # mapped differently. For example, it will likely be mapped to some exceptions + # in Java, but more likely mapped to some error codes in C. + # # Other uses + # The error model and the `Status` message can be used in a variety of + # environments, either with or without APIs, to provide a + # consistent developer experience across different environments. + # Example uses of this error model include: + # - Partial errors. If a service needs to return partial errors to the client, + # it may embed the `Status` in the normal response to indicate the partial + # errors. + # - Workflow errors. A typical workflow has multiple steps. Each step may + # have a `Status` message for error reporting. + # - Batch operations. If a client uses batch request and batch response, the + # `Status` message should be used directly inside batch response, one for + # each error sub-response. + # - Asynchronous operations. If an API call embeds asynchronous operation + # results in its response, the status of those operations should be + # represented directly using the `Status` message. + # - Logging. If some API errors are stored in logs, the message `Status` could + # be used directly after any stripping needed for security/privacy reasons. + class Status + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # A developer-facing error message, which should be in English. Any + # user-facing error message should be localized and sent in the + # google.rpc.Status.details field, or localized by the client. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + end + end +end diff --git a/generated/google/apis/vision_v1p1beta1/representations.rb b/generated/google/apis/vision_v1p1beta1/representations.rb new file mode 100644 index 000000000..9719cac40 --- /dev/null +++ b/generated/google/apis/vision_v1p1beta1/representations.rb @@ -0,0 +1,728 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module VisionV1p1beta1 + + class Color + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1AnnotateImageRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1AnnotateImageResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1Block + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1BoundingPoly + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ColorInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1CropHint + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1CropHintsAnnotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1CropHintsParams + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1DominantColorsAnnotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1EntityAnnotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1FaceAnnotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1FaceAnnotationLandmark + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1Feature + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1Image + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ImageContext + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ImageProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ImageSource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1LatLongRect + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1LocationInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1Page + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1Paragraph + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1Position + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1Property + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1SafeSearchAnnotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1Symbol + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1TextAnnotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1TextAnnotationTextProperty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1Vertex + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1WebDetection + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1WebDetectionParams + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1WebDetectionWebEntity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1WebDetectionWebImage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1WebDetectionWebLabel + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1WebDetectionWebPage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1Word + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LatLng + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Status + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Color + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :alpha, as: 'alpha' + property :blue, as: 'blue' + property :green, as: 'green' + property :red, as: 'red' + end + end + + class GoogleCloudVisionV1p1beta1AnnotateImageRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :features, as: 'features', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Feature, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Feature::Representation + + property :image, as: 'image', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Image, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Image::Representation + + property :image_context, as: 'imageContext', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ImageContext, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ImageContext::Representation + + end + end + + class GoogleCloudVisionV1p1beta1AnnotateImageResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :crop_hints_annotation, as: 'cropHintsAnnotation', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1CropHintsAnnotation, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1CropHintsAnnotation::Representation + + property :error, as: 'error', class: Google::Apis::VisionV1p1beta1::Status, decorator: Google::Apis::VisionV1p1beta1::Status::Representation + + collection :face_annotations, as: 'faceAnnotations', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1FaceAnnotation, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1FaceAnnotation::Representation + + property :full_text_annotation, as: 'fullTextAnnotation', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotation, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotation::Representation + + property :image_properties_annotation, as: 'imagePropertiesAnnotation', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ImageProperties, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ImageProperties::Representation + + collection :label_annotations, as: 'labelAnnotations', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1EntityAnnotation, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1EntityAnnotation::Representation + + collection :landmark_annotations, as: 'landmarkAnnotations', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1EntityAnnotation, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1EntityAnnotation::Representation + + collection :logo_annotations, as: 'logoAnnotations', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1EntityAnnotation, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1EntityAnnotation::Representation + + property :safe_search_annotation, as: 'safeSearchAnnotation', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1SafeSearchAnnotation, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1SafeSearchAnnotation::Representation + + collection :text_annotations, as: 'textAnnotations', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1EntityAnnotation, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1EntityAnnotation::Representation + + property :web_detection, as: 'webDetection', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetection, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetection::Representation + + end + end + + class GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :requests, as: 'requests', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AnnotateImageRequest, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AnnotateImageRequest::Representation + + end + end + + class GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :responses, as: 'responses', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AnnotateImageResponse, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AnnotateImageResponse::Representation + + end + end + + class GoogleCloudVisionV1p1beta1Block + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :block_type, as: 'blockType' + property :bounding_box, as: 'boundingBox', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly::Representation + + property :confidence, as: 'confidence' + collection :paragraphs, as: 'paragraphs', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Paragraph, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Paragraph::Representation + + property :property, as: 'property', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty::Representation + + end + end + + class GoogleCloudVisionV1p1beta1BoundingPoly + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :vertices, as: 'vertices', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Vertex, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Vertex::Representation + + end + end + + class GoogleCloudVisionV1p1beta1ColorInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :color, as: 'color', class: Google::Apis::VisionV1p1beta1::Color, decorator: Google::Apis::VisionV1p1beta1::Color::Representation + + property :pixel_fraction, as: 'pixelFraction' + property :score, as: 'score' + end + end + + class GoogleCloudVisionV1p1beta1CropHint + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly::Representation + + property :confidence, as: 'confidence' + property :importance_fraction, as: 'importanceFraction' + end + end + + class GoogleCloudVisionV1p1beta1CropHintsAnnotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :crop_hints, as: 'cropHints', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1CropHint, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1CropHint::Representation + + end + end + + class GoogleCloudVisionV1p1beta1CropHintsParams + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :aspect_ratios, as: 'aspectRatios' + end + end + + class GoogleCloudVisionV1p1beta1DominantColorsAnnotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :colors, as: 'colors', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ColorInfo, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ColorInfo::Representation + + end + end + + class GoogleCloudVisionV1p1beta1EntityAnnotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly::Representation + + property :confidence, as: 'confidence' + property :description, as: 'description' + property :locale, as: 'locale' + collection :locations, as: 'locations', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1LocationInfo, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1LocationInfo::Representation + + property :mid, as: 'mid' + collection :properties, as: 'properties', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Property, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Property::Representation + + property :score, as: 'score' + property :topicality, as: 'topicality' + end + end + + class GoogleCloudVisionV1p1beta1FaceAnnotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :anger_likelihood, as: 'angerLikelihood' + property :blurred_likelihood, as: 'blurredLikelihood' + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly::Representation + + property :detection_confidence, as: 'detectionConfidence' + property :fd_bounding_poly, as: 'fdBoundingPoly', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly::Representation + + property :headwear_likelihood, as: 'headwearLikelihood' + property :joy_likelihood, as: 'joyLikelihood' + property :landmarking_confidence, as: 'landmarkingConfidence' + collection :landmarks, as: 'landmarks', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1FaceAnnotationLandmark, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1FaceAnnotationLandmark::Representation + + property :pan_angle, as: 'panAngle' + property :roll_angle, as: 'rollAngle' + property :sorrow_likelihood, as: 'sorrowLikelihood' + property :surprise_likelihood, as: 'surpriseLikelihood' + property :tilt_angle, as: 'tiltAngle' + property :under_exposed_likelihood, as: 'underExposedLikelihood' + end + end + + class GoogleCloudVisionV1p1beta1FaceAnnotationLandmark + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :position, as: 'position', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Position, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Position::Representation + + property :type, as: 'type' + end + end + + class GoogleCloudVisionV1p1beta1Feature + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :max_results, as: 'maxResults' + property :model, as: 'model' + property :type, as: 'type' + end + end + + class GoogleCloudVisionV1p1beta1Image + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content, :base64 => true, as: 'content' + property :source, as: 'source', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ImageSource, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ImageSource::Representation + + end + end + + class GoogleCloudVisionV1p1beta1ImageContext + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :crop_hints_params, as: 'cropHintsParams', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1CropHintsParams, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1CropHintsParams::Representation + + collection :language_hints, as: 'languageHints' + property :lat_long_rect, as: 'latLongRect', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1LatLongRect, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1LatLongRect::Representation + + property :web_detection_params, as: 'webDetectionParams', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionParams, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionParams::Representation + + end + end + + class GoogleCloudVisionV1p1beta1ImageProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dominant_colors, as: 'dominantColors', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1DominantColorsAnnotation, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1DominantColorsAnnotation::Representation + + end + end + + class GoogleCloudVisionV1p1beta1ImageSource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :gcs_image_uri, as: 'gcsImageUri' + property :image_uri, as: 'imageUri' + end + end + + class GoogleCloudVisionV1p1beta1LatLongRect + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :max_lat_lng, as: 'maxLatLng', class: Google::Apis::VisionV1p1beta1::LatLng, decorator: Google::Apis::VisionV1p1beta1::LatLng::Representation + + property :min_lat_lng, as: 'minLatLng', class: Google::Apis::VisionV1p1beta1::LatLng, decorator: Google::Apis::VisionV1p1beta1::LatLng::Representation + + end + end + + class GoogleCloudVisionV1p1beta1LocationInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :lat_lng, as: 'latLng', class: Google::Apis::VisionV1p1beta1::LatLng, decorator: Google::Apis::VisionV1p1beta1::LatLng::Representation + + end + end + + class GoogleCloudVisionV1p1beta1Page + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :blocks, as: 'blocks', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Block, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Block::Representation + + property :confidence, as: 'confidence' + property :height, as: 'height' + property :property, as: 'property', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty::Representation + + property :width, as: 'width' + end + end + + class GoogleCloudVisionV1p1beta1Paragraph + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_box, as: 'boundingBox', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly::Representation + + property :confidence, as: 'confidence' + property :property, as: 'property', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty::Representation + + collection :words, as: 'words', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Word, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Word::Representation + + end + end + + class GoogleCloudVisionV1p1beta1Position + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :x, as: 'x' + property :y, as: 'y' + property :z, as: 'z' + end + end + + class GoogleCloudVisionV1p1beta1Property + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :uint64_value, :numeric_string => true, as: 'uint64Value' + property :value, as: 'value' + end + end + + class GoogleCloudVisionV1p1beta1SafeSearchAnnotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :adult, as: 'adult' + property :medical, as: 'medical' + property :racy, as: 'racy' + property :spoof, as: 'spoof' + property :violence, as: 'violence' + end + end + + class GoogleCloudVisionV1p1beta1Symbol + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_box, as: 'boundingBox', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly::Representation + + property :confidence, as: 'confidence' + property :property, as: 'property', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty::Representation + + property :text, as: 'text' + end + end + + class GoogleCloudVisionV1p1beta1TextAnnotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :pages, as: 'pages', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Page, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Page::Representation + + property :text, as: 'text' + end + end + + class GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :is_prefix, as: 'isPrefix' + property :type, as: 'type' + end + end + + class GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :language_code, as: 'languageCode' + end + end + + class GoogleCloudVisionV1p1beta1TextAnnotationTextProperty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :detected_break, as: 'detectedBreak', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak::Representation + + collection :detected_languages, as: 'detectedLanguages', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage::Representation + + end + end + + class GoogleCloudVisionV1p1beta1Vertex + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :x, as: 'x' + property :y, as: 'y' + end + end + + class GoogleCloudVisionV1p1beta1WebDetection + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :best_guess_labels, as: 'bestGuessLabels', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebLabel, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebLabel::Representation + + collection :full_matching_images, as: 'fullMatchingImages', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebImage, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebImage::Representation + + collection :pages_with_matching_images, as: 'pagesWithMatchingImages', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebPage, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebPage::Representation + + collection :partial_matching_images, as: 'partialMatchingImages', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebImage, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebImage::Representation + + collection :visually_similar_images, as: 'visuallySimilarImages', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebImage, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebImage::Representation + + collection :web_entities, as: 'webEntities', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebEntity, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebEntity::Representation + + end + end + + class GoogleCloudVisionV1p1beta1WebDetectionParams + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :include_geo_results, as: 'includeGeoResults' + end + end + + class GoogleCloudVisionV1p1beta1WebDetectionWebEntity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :entity_id, as: 'entityId' + property :score, as: 'score' + end + end + + class GoogleCloudVisionV1p1beta1WebDetectionWebImage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :score, as: 'score' + property :url, as: 'url' + end + end + + class GoogleCloudVisionV1p1beta1WebDetectionWebLabel + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :label, as: 'label' + property :language_code, as: 'languageCode' + end + end + + class GoogleCloudVisionV1p1beta1WebDetectionWebPage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :full_matching_images, as: 'fullMatchingImages', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebImage, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebImage::Representation + + property :page_title, as: 'pageTitle' + collection :partial_matching_images, as: 'partialMatchingImages', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebImage, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionWebImage::Representation + + property :score, as: 'score' + property :url, as: 'url' + end + end + + class GoogleCloudVisionV1p1beta1Word + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_box, as: 'boundingBox', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly::Representation + + property :confidence, as: 'confidence' + property :property, as: 'property', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty::Representation + + collection :symbols, as: 'symbols', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Symbol, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Symbol::Representation + + end + end + + class LatLng + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :latitude, as: 'latitude' + property :longitude, as: 'longitude' + end + end + + class Status + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + end + end +end diff --git a/generated/google/apis/qpx_express_v1/service.rb b/generated/google/apis/vision_v1p1beta1/service.rb similarity index 57% rename from generated/google/apis/qpx_express_v1/service.rb rename to generated/google/apis/vision_v1p1beta1/service.rb index 56885b67b..57442b953 100644 --- a/generated/google/apis/qpx_express_v1/service.rb +++ b/generated/google/apis/vision_v1p1beta1/service.rb @@ -19,19 +19,21 @@ require 'google/apis/errors' module Google module Apis - module QpxExpressV1 - # QPX Express API + module VisionV1p1beta1 + # Google Cloud Vision API # - # Finds the least expensive flights between an origin and a destination. + # Integrates Google Vision features, including image labeling, face, logo, and + # landmark detection, optical character recognition (OCR), and detection of + # explicit content, into applications. # # @example - # require 'google/apis/qpx_express_v1' + # require 'google/apis/vision_v1p1beta1' # - # QpxExpress = Google::Apis::QpxExpressV1 # Alias the module - # service = QpxExpress::QPXExpressService.new + # Vision = Google::Apis::VisionV1p1beta1 # Alias the module + # service = Vision::VisionService.new # - # @see http://developers.google.com/qpx-express - class QPXExpressService < Google::Apis::Core::BaseService + # @see https://cloud.google.com/vision/ + class VisionService < Google::Apis::Core::BaseService # @return [String] # 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. @@ -40,51 +42,40 @@ module Google # @return [String] # 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. - # Overrides userIp if both are provided. attr_accessor :quota_user - # @return [String] - # IP address of the site where the request originates. Use this if you want to - # enforce per-user limits. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'qpxExpress/v1/trips/') - @batch_path = 'batch/qpxExpress/v1' + super('https://vision.googleapis.com/', '') + @batch_path = 'batch' end - # Returns a list of flights. - # @param [Google::Apis::QpxExpressV1::SearchTripsRequest] search_trips_request_object + # Run image detection and annotation for a batch of images. + # @param [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest] google_cloud_vision_v1p1beta1_batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. - # Overrides userIp if both are provided. - # @param [String] user_ip - # IP address of the site where the request originates. Use this if you want to - # enforce per-user limits. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::QpxExpressV1::SearchTripsResponse] parsed result object + # @yieldparam result [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [Google::Apis::QpxExpressV1::SearchTripsResponse] + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def search_trips(search_trips_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'search', options) - command.request_representation = Google::Apis::QpxExpressV1::SearchTripsRequest::Representation - command.request_object = search_trips_request_object - command.response_representation = Google::Apis::QpxExpressV1::SearchTripsResponse::Representation - command.response_class = Google::Apis::QpxExpressV1::SearchTripsResponse + def annotate_image(google_cloud_vision_v1p1beta1_batch_annotate_images_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1p1beta1/images:annotate', options) + command.request_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest::Representation + command.request_object = google_cloud_vision_v1p1beta1_batch_annotate_images_request_object + command.response_representation = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse::Representation + command.response_class = Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -93,7 +84,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/youtube_partner_v1.rb b/generated/google/apis/youtube_partner_v1.rb index 5c3cddcc4..365dbe554 100644 --- a/generated/google/apis/youtube_partner_v1.rb +++ b/generated/google/apis/youtube_partner_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/youtube/partner/ module YoutubePartnerV1 VERSION = 'V1' - REVISION = '20171002' + REVISION = '20171113' # View and manage your assets and associated content on YouTube AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner' diff --git a/generated/google/apis/youtube_partner_v1/classes.rb b/generated/google/apis/youtube_partner_v1/classes.rb index 9ce28c67a..25257d3d6 100644 --- a/generated/google/apis/youtube_partner_v1/classes.rb +++ b/generated/google/apis/youtube_partner_v1/classes.rb @@ -2651,6 +2651,11 @@ module Google # @return [String] attr_accessor :status + # The package status reports. + # Corresponds to the JSON property `statusReports` + # @return [Array] + attr_accessor :status_reports + # The package creation time. The value is specified in RFC 3339 (YYYY-MM-DDThh: # mm:ss.000Z) format. # Corresponds to the JSON property `timeCreated` @@ -2680,6 +2685,7 @@ module Google @locale = args[:locale] if args.key?(:locale) @name = args[:name] if args.key?(:name) @status = args[:status] if args.key?(:status) + @status_reports = args[:status_reports] if args.key?(:status_reports) @time_created = args[:time_created] if args.key?(:time_created) @type = args[:type] if args.key?(:type) @uploader_name = args[:uploader_name] if args.key?(:uploader_name) @@ -3529,6 +3535,83 @@ module Google end end + # + class SpreadsheetTemplate + include Google::Apis::Core::Hashable + + # The type of the API resource. For spreadsheet template resources, the value is + # youtubePartner#spreadsheetTemplate. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The template status. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + # The template content. + # Corresponds to the JSON property `templateContent` + # @return [String] + attr_accessor :template_content + + # The template name. + # Corresponds to the JSON property `templateName` + # @return [String] + attr_accessor :template_name + + # The template type. + # Corresponds to the JSON property `templateType` + # @return [String] + attr_accessor :template_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @kind = args[:kind] if args.key?(:kind) + @status = args[:status] if args.key?(:status) + @template_content = args[:template_content] if args.key?(:template_content) + @template_name = args[:template_name] if args.key?(:template_name) + @template_type = args[:template_type] if args.key?(:template_type) + end + end + + # + class SpreadsheetTemplateListResponse + include Google::Apis::Core::Hashable + + # A list of spreadsheet templates (youtubePartner#spreadsheetTemplate) resources + # that match the request criteria. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # The type of the API response. For this operation, the value is youtubePartner# + # spreadsheetTemplateList. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The status of the API response. + # Corresponds to the JSON property `status` + # @return [String] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + @status = args[:status] if args.key?(:status) + end + end + # class StateCompleted include Google::Apis::Core::Hashable @@ -3554,6 +3637,31 @@ module Google end end + # + class StatusReport + include Google::Apis::Core::Hashable + + # The content of the report message. Used only in Hybrid. + # Corresponds to the JSON property `statusContent` + # @return [String] + attr_accessor :status_content + + # Status file name. Used only in Hybrid. + # Corresponds to the JSON property `statusFileName` + # @return [String] + attr_accessor :status_file_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @status_content = args[:status_content] if args.key?(:status_content) + @status_file_name = args[:status_file_name] if args.key?(:status_file_name) + end + end + # class TerritoryCondition include Google::Apis::Core::Hashable diff --git a/generated/google/apis/youtube_partner_v1/representations.rb b/generated/google/apis/youtube_partner_v1/representations.rb index 75ece704b..7973faadc 100644 --- a/generated/google/apis/youtube_partner_v1/representations.rb +++ b/generated/google/apis/youtube_partner_v1/representations.rb @@ -466,12 +466,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class SpreadsheetTemplate + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SpreadsheetTemplateListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class StateCompleted class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class StatusReport + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class TerritoryCondition class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1259,6 +1277,8 @@ module Google property :locale, as: 'locale' property :name, as: 'name' property :status, as: 'status' + collection :status_reports, as: 'statusReports', class: Google::Apis::YoutubePartnerV1::StatusReport, decorator: Google::Apis::YoutubePartnerV1::StatusReport::Representation + property :time_created, as: 'timeCreated', type: DateTime property :type, as: 'type' @@ -1492,6 +1512,27 @@ module Google end end + class SpreadsheetTemplate + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :kind, as: 'kind' + property :status, as: 'status' + property :template_content, as: 'templateContent' + property :template_name, as: 'templateName' + property :template_type, as: 'templateType' + end + end + + class SpreadsheetTemplateListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::SpreadsheetTemplate, decorator: Google::Apis::YoutubePartnerV1::SpreadsheetTemplate::Representation + + property :kind, as: 'kind' + property :status, as: 'status' + end + end + class StateCompleted # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1500,6 +1541,14 @@ module Google end end + class StatusReport + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :status_content, as: 'statusContent' + property :status_file_name, as: 'statusFileName' + end + end + class TerritoryCondition # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/youtube_partner_v1/service.rb b/generated/google/apis/youtube_partner_v1/service.rb index 2b2784cdd..1c9832ab9 100644 --- a/generated/google/apis/youtube_partner_v1/service.rb +++ b/generated/google/apis/youtube_partner_v1/service.rb @@ -2957,6 +2957,48 @@ module Google execute_or_queue_command(command, &block) end + # Retrieves a list of spreadsheet templates for a content owner. + # @param [String] locale + # The locale parameter identifies the desired language for templates in the API + # response. The value is a string that contains a BCP-47 language code. The + # default value is en. + # @param [String] on_behalf_of_content_owner + # The onBehalfOfContentOwner parameter identifies the content owner that the + # user is acting on behalf of. This parameter supports users whose accounts are + # associated with multiple content owners. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # 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. + # Overrides userIp if both are provided. + # @param [String] user_ip + # IP address of the site where the request originates. Use this if you want to + # enforce per-user limits. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_spreadsheet_templates(locale: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) + command = make_simple_command(:get, 'spreadsheetTemplate', options) + command.response_representation = Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse::Representation + command.response_class = Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse + command.query['locale'] = locale unless locale.nil? + command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + command.query['userIp'] = user_ip unless user_ip.nil? + execute_or_queue_command(command, &block) + end + # Retrieves a list of uploaders for a content owner. # @param [String] on_behalf_of_content_owner # The onBehalfOfContentOwner parameter identifies the content owner that the diff --git a/generated/google/apis/youtube_v3.rb b/generated/google/apis/youtube_v3.rb index 3cce1c2c1..a67de5b2a 100644 --- a/generated/google/apis/youtube_v3.rb +++ b/generated/google/apis/youtube_v3.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/youtube/v3 module YoutubeV3 VERSION = 'V3' - REVISION = '20170918' + REVISION = '20171101' # Manage your YouTube account AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube' diff --git a/google-api-client.gemspec b/google-api-client.gemspec index 3443364e8..e24e47731 100644 --- a/google-api-client.gemspec +++ b/google-api-client.gemspec @@ -24,7 +24,7 @@ Gem::Specification.new do |spec| spec.add_runtime_dependency 'retriable', '>= 2.0', '< 4.0' spec.add_runtime_dependency 'addressable', '~> 2.5', '>= 2.5.1' spec.add_runtime_dependency 'mime-types', '~> 3.0' - spec.add_runtime_dependency 'googleauth', '~> 0.5' + spec.add_runtime_dependency 'googleauth', '>= 0.5', '< 0.7.0' spec.add_runtime_dependency 'httpclient', '>= 2.8.1', '< 3.0' spec.add_development_dependency 'thor', '~> 0.19' spec.add_development_dependency 'activesupport', '>= 4.2', '< 5.1' diff --git a/lib/google/apis/generator/model.rb b/lib/google/apis/generator/model.rb index d819a68e7..30f381c61 100644 --- a/lib/google/apis/generator/model.rb +++ b/lib/google/apis/generator/model.rb @@ -55,8 +55,14 @@ module Google return 'Fixnum' if format == 'uint64' return TYPE_MAP[type] when 'array' + if items == self + return sprintf('Array<%s>', qualified_name) + end return sprintf('Array<%s>', items.generated_type) when 'hash' + if additional_properties == self + return sprintf('Hash', qualified_name) + end return sprintf('Hash', additional_properties.generated_type) when 'object' return qualified_name @@ -81,16 +87,16 @@ module Google return [] if parameters.nil? parameters.values.select { |param| param.location == 'query' } end - + def required_parameters return [] if parameter_order.nil? || parameters.nil? parameter_order.map { |name| parameters[name] }.select { |param| param.location == 'path' || param.required } end - + def optional_query_parameters query_parameters.select { |param| param.required != true } end - + end class RestResource diff --git a/lib/google/apis/generator/templates/_class.tmpl b/lib/google/apis/generator/templates/_class.tmpl index 5658483d3..44a193979 100644 --- a/lib/google/apis/generator/templates/_class.tmpl +++ b/lib/google/apis/generator/templates/_class.tmpl @@ -1,4 +1,4 @@ -<% if cls.type == 'object' -%> +<% if cls.type == 'object' || (cls.type == 'hash' && cls.properties.length > 0) -%> # <%= block_comment(cls.description, 0, 1) %> class <%= cls.generated_class_name %><% if cls.base_ref %> < <%= cls.base_ref.generated_type %><% end %> diff --git a/lib/google/apis/version.rb b/lib/google/apis/version.rb index b7c304424..e6d1f4a7f 100644 --- a/lib/google/apis/version.rb +++ b/lib/google/apis/version.rb @@ -15,7 +15,7 @@ module Google module Apis # Client library version - VERSION = '0.15.0' + VERSION = '0.17.3' # Current operating system # @private diff --git a/spec/fixtures/files/test_api.json b/spec/fixtures/files/test_api.json index 29a46871a..fad3f1d96 100644 --- a/spec/fixtures/files/test_api.json +++ b/spec/fixtures/files/test_api.json @@ -90,6 +90,9 @@ "hat": { "$ref": "Hat" }, + "recursiveHat": { + "$ref": "RecursiveHat" + }, "properties": { "$ref": "HashLikeThing" }, @@ -131,6 +134,49 @@ ] } }, + "RecursiveHat": { + "id": "RecursiveHat", + "type": "object", + "properties": { + "bool": { + "type": "boolean", + "description": "The bool value." + }, + "double": { + "type": "number", + "description": "The double value.", + "format": "double" + }, + "image": { + "$ref": "Image", + "description": "The image value." + }, + "int": { + "type": "integer", + "description": "The int value.", + "format": "int32" + }, + "kind": { + "type": "string", + "description": "The kind, fixed to \"test#recursiveHat\".", + "default": "test#recursiveHat" + }, + "list": { + "type": "array", + "description": "The list of typed values.", + "items": { + "$ref": "RecursiveHat" + } + }, + "string": { + "type": "string", + "description": "The string value." + } + }, + "additionalProperties": { + "$ref": "RecursiveHat" + } + }, "TopHat": { "type": "object", "properties": {