diff --git a/api_names_out.yaml b/api_names_out.yaml index 753d4cf78..b92b2543a 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -369,6 +369,8 @@ "/adexchangebuyer2:v2beta1/Empty": empty "/adexchangebuyer2:v2beta1/FilterSet": filter_set "/adexchangebuyer2:v2beta1/FilterSet/absoluteDateRange": absolute_date_range +"/adexchangebuyer2:v2beta1/FilterSet/breakdownDimensions": breakdown_dimensions +"/adexchangebuyer2:v2beta1/FilterSet/breakdownDimensions/breakdown_dimension": breakdown_dimension "/adexchangebuyer2:v2beta1/FilterSet/buyerAccountId": buyer_account_id "/adexchangebuyer2:v2beta1/FilterSet/creativeId": creative_id "/adexchangebuyer2:v2beta1/FilterSet/dealId": deal_id @@ -660,6 +662,7 @@ "/adexchangebuyer2:v2beta1/RemoveDealAssociationRequest/association": association "/adexchangebuyer2:v2beta1/ResumeProposalRequest": resume_proposal_request "/adexchangebuyer2:v2beta1/RowDimensions": row_dimensions +"/adexchangebuyer2:v2beta1/RowDimensions/publisherIdentifier": publisher_identifier "/adexchangebuyer2:v2beta1/RowDimensions/timeInterval": time_interval "/adexchangebuyer2:v2beta1/SecurityContext": security_context "/adexchangebuyer2:v2beta1/SecurityContext/securities": securities @@ -4368,6 +4371,7 @@ "/alertcenter:v1beta1/Alert/customerId": customer_id "/alertcenter:v1beta1/Alert/data": data "/alertcenter:v1beta1/Alert/data/datum": datum +"/alertcenter:v1beta1/Alert/deleted": deleted "/alertcenter:v1beta1/Alert/endTime": end_time "/alertcenter:v1beta1/Alert/securityInvestigationToolLink": security_investigation_tool_link "/alertcenter:v1beta1/Alert/source": source @@ -6192,7 +6196,10 @@ "/androidenterprise:v1/AppUpdateEvent": app_update_event "/androidenterprise:v1/AppUpdateEvent/productId": product_id "/androidenterprise:v1/AppVersion": app_version +"/androidenterprise:v1/AppVersion/isProduction": is_production "/androidenterprise:v1/AppVersion/track": track +"/androidenterprise:v1/AppVersion/trackId": track_id +"/androidenterprise:v1/AppVersion/trackId/track_id": track_id "/androidenterprise:v1/AppVersion/versionCode": version_code "/androidenterprise:v1/AppVersion/versionString": version_string "/androidenterprise:v1/ApprovalUrlInfo": approval_url_info @@ -6363,6 +6370,8 @@ "/androidenterprise:v1/Policy/productPolicy": product_policy "/androidenterprise:v1/Policy/productPolicy/product_policy": product_policy "/androidenterprise:v1/Product": product +"/androidenterprise:v1/Product/appTracks": app_tracks +"/androidenterprise:v1/Product/appTracks/app_track": app_track "/androidenterprise:v1/Product/appVersion": app_version "/androidenterprise:v1/Product/appVersion/app_version": app_version "/androidenterprise:v1/Product/authorName": author_name @@ -6407,6 +6416,8 @@ "/androidenterprise:v1/ProductPermissions/productId": product_id "/androidenterprise:v1/ProductPolicy": product_policy "/androidenterprise:v1/ProductPolicy/productId": product_id +"/androidenterprise:v1/ProductPolicy/trackIds": track_ids +"/androidenterprise:v1/ProductPolicy/trackIds/track_id": track_id "/androidenterprise:v1/ProductPolicy/tracks": tracks "/androidenterprise:v1/ProductPolicy/tracks/track": track "/androidenterprise:v1/ProductSet": product_set @@ -6421,6 +6432,8 @@ "/androidenterprise:v1/ProductSigningCertificate/certificateHashSha256": certificate_hash_sha256 "/androidenterprise:v1/ProductVisibility": product_visibility "/androidenterprise:v1/ProductVisibility/productId": product_id +"/androidenterprise:v1/ProductVisibility/trackIds": track_ids +"/androidenterprise:v1/ProductVisibility/trackIds/track_id": track_id "/androidenterprise:v1/ProductVisibility/tracks": tracks "/androidenterprise:v1/ProductVisibility/tracks/track": track "/androidenterprise:v1/ProductsApproveRequest": approve_product_request @@ -6481,6 +6494,9 @@ "/androidenterprise:v1/TokenPagination": token_pagination "/androidenterprise:v1/TokenPagination/nextPageToken": next_page_token "/androidenterprise:v1/TokenPagination/previousPageToken": previous_page_token +"/androidenterprise:v1/TrackInfo": track_info +"/androidenterprise:v1/TrackInfo/trackAlias": track_alias +"/androidenterprise:v1/TrackInfo/trackId": track_id "/androidenterprise:v1/User": user "/androidenterprise:v1/User/accountIdentifier": account_identifier "/androidenterprise:v1/User/accountType": account_type @@ -7074,6 +7090,7 @@ "/androidmanagement:v1/PasswordRequirements/passwordMinimumSymbols": password_minimum_symbols "/androidmanagement:v1/PasswordRequirements/passwordMinimumUpperCase": password_minimum_upper_case "/androidmanagement:v1/PasswordRequirements/passwordQuality": password_quality +"/androidmanagement:v1/PasswordRequirements/passwordScope": password_scope "/androidmanagement:v1/PermissionGrant": permission_grant "/androidmanagement:v1/PermissionGrant/permission": permission "/androidmanagement:v1/PermissionGrant/policy": policy @@ -10981,6 +10998,12 @@ "/bigquery:v2/QueryTimelineSample/pendingInputs": pending_inputs "/bigquery:v2/QueryTimelineSample/pendingUnits": pending_units "/bigquery:v2/QueryTimelineSample/totalSlotMs": total_slot_ms +"/bigquery:v2/RangePartitioning": range_partitioning +"/bigquery:v2/RangePartitioning/field": field +"/bigquery:v2/RangePartitioning/range": range +"/bigquery:v2/RangePartitioning/range/end": end +"/bigquery:v2/RangePartitioning/range/interval": interval +"/bigquery:v2/RangePartitioning/range/start": start "/bigquery:v2/Streamingbuffer": streamingbuffer "/bigquery:v2/Streamingbuffer/estimatedBytes": estimated_bytes "/bigquery:v2/Streamingbuffer/estimatedRows": estimated_rows @@ -11003,7 +11026,10 @@ "/bigquery:v2/Table/model": model "/bigquery:v2/Table/numBytes": num_bytes "/bigquery:v2/Table/numLongTermBytes": num_long_term_bytes +"/bigquery:v2/Table/numPhysicalBytes": num_physical_bytes "/bigquery:v2/Table/numRows": num_rows +"/bigquery:v2/Table/rangePartitioning": range_partitioning +"/bigquery:v2/Table/requirePartitionFilter": require_partition_filter "/bigquery:v2/Table/schema": schema "/bigquery:v2/Table/selfLink": self_link "/bigquery:v2/Table/streamingBuffer": streaming_buffer @@ -13655,6 +13681,8 @@ "/civicinfo:v2/PollingLocation/address": address "/civicinfo:v2/PollingLocation/endDate": end_date "/civicinfo:v2/PollingLocation/id": id +"/civicinfo:v2/PollingLocation/latitude": latitude +"/civicinfo:v2/PollingLocation/longitude": longitude "/civicinfo:v2/PollingLocation/name": name "/civicinfo:v2/PollingLocation/notes": notes "/civicinfo:v2/PollingLocation/pollingHours": polling_hours @@ -15014,6 +15042,19 @@ "/clouderrorreporting:v1beta1/fields": fields "/clouderrorreporting:v1beta1/key": key "/clouderrorreporting:v1beta1/quotaUser": quota_user +"/cloudfunctions:v1/AuditConfig": audit_config +"/cloudfunctions:v1/AuditConfig/auditLogConfigs": audit_log_configs +"/cloudfunctions:v1/AuditConfig/auditLogConfigs/audit_log_config": audit_log_config +"/cloudfunctions:v1/AuditConfig/service": service +"/cloudfunctions:v1/AuditLogConfig": audit_log_config +"/cloudfunctions:v1/AuditLogConfig/exemptedMembers": exempted_members +"/cloudfunctions:v1/AuditLogConfig/exemptedMembers/exempted_member": exempted_member +"/cloudfunctions:v1/AuditLogConfig/logType": log_type +"/cloudfunctions:v1/Binding": binding +"/cloudfunctions:v1/Binding/condition": condition +"/cloudfunctions:v1/Binding/members": members +"/cloudfunctions:v1/Binding/members/member": member +"/cloudfunctions:v1/Binding/role": role "/cloudfunctions:v1/CallFunctionRequest": call_function_request "/cloudfunctions:v1/CallFunctionRequest/data": data "/cloudfunctions:v1/CallFunctionResponse": call_function_response @@ -15042,11 +15083,17 @@ "/cloudfunctions:v1/CloudFunction/timeout": timeout "/cloudfunctions:v1/CloudFunction/updateTime": update_time "/cloudfunctions:v1/CloudFunction/versionId": version_id +"/cloudfunctions:v1/CloudFunction/vpcConnector": vpc_connector "/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/Expr": expr +"/cloudfunctions:v1/Expr/description": description +"/cloudfunctions:v1/Expr/expression": expression +"/cloudfunctions:v1/Expr/location": location +"/cloudfunctions:v1/Expr/title": title "/cloudfunctions:v1/FailurePolicy": failure_policy "/cloudfunctions:v1/FailurePolicy/retry": retry "/cloudfunctions:v1/GenerateDownloadUrlRequest": generate_download_url_request @@ -15100,7 +15147,17 @@ "/cloudfunctions:v1/OperationMetadataV1Beta2/type": type "/cloudfunctions:v1/OperationMetadataV1Beta2/updateTime": update_time "/cloudfunctions:v1/OperationMetadataV1Beta2/versionId": version_id +"/cloudfunctions:v1/Policy": policy +"/cloudfunctions:v1/Policy/auditConfigs": audit_configs +"/cloudfunctions:v1/Policy/auditConfigs/audit_config": audit_config +"/cloudfunctions:v1/Policy/bindings": bindings +"/cloudfunctions:v1/Policy/bindings/binding": binding +"/cloudfunctions:v1/Policy/etag": etag +"/cloudfunctions:v1/Policy/version": version "/cloudfunctions:v1/Retry": retry +"/cloudfunctions:v1/SetIamPolicyRequest": set_iam_policy_request +"/cloudfunctions:v1/SetIamPolicyRequest/policy": policy +"/cloudfunctions:v1/SetIamPolicyRequest/updateMask": update_mask "/cloudfunctions:v1/SourceRepository": source_repository "/cloudfunctions:v1/SourceRepository/deployedUrl": deployed_url "/cloudfunctions:v1/SourceRepository/url": url @@ -15110,6 +15167,12 @@ "/cloudfunctions:v1/Status/details/detail": detail "/cloudfunctions:v1/Status/details/detail/detail": detail "/cloudfunctions:v1/Status/message": message +"/cloudfunctions:v1/TestIamPermissionsRequest": test_iam_permissions_request +"/cloudfunctions:v1/TestIamPermissionsRequest/permissions": permissions +"/cloudfunctions:v1/TestIamPermissionsRequest/permissions/permission": permission +"/cloudfunctions:v1/TestIamPermissionsResponse": test_iam_permissions_response +"/cloudfunctions:v1/TestIamPermissionsResponse/permissions": permissions +"/cloudfunctions:v1/TestIamPermissionsResponse/permissions/permission": permission "/cloudfunctions:v1/cloudfunctions.operations.get": get_operation "/cloudfunctions:v1/cloudfunctions.operations.get/name": name "/cloudfunctions:v1/cloudfunctions.operations.list": list_operations @@ -15129,6 +15192,8 @@ "/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.getIamPolicy": get_project_location_function_iam_policy +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.getIamPolicy/resource": resource "/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 @@ -15136,6 +15201,10 @@ "/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.functions.setIamPolicy": set_function_iam_policy +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.setIamPolicy/resource": resource +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.testIamPermissions": test_function_iam_permissions +"/cloudfunctions:v1/cloudfunctions.projects.locations.functions.testIamPermissions/resource": resource "/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 @@ -16630,6 +16699,686 @@ "/cloudresourcemanager:v2beta1/fields": fields "/cloudresourcemanager:v2beta1/key": key "/cloudresourcemanager:v2beta1/quotaUser": quota_user +"/cloudsearch:v1/BooleanOperatorOptions": boolean_operator_options +"/cloudsearch:v1/BooleanOperatorOptions/operatorName": operator_name +"/cloudsearch:v1/BooleanPropertyOptions": boolean_property_options +"/cloudsearch:v1/BooleanPropertyOptions/operatorOptions": operator_options +"/cloudsearch:v1/CompositeFilter": composite_filter +"/cloudsearch:v1/CompositeFilter/logicOperator": logic_operator +"/cloudsearch:v1/CompositeFilter/subFilters": sub_filters +"/cloudsearch:v1/CompositeFilter/subFilters/sub_filter": sub_filter +"/cloudsearch:v1/CustomerIndexStats": customer_index_stats +"/cloudsearch:v1/CustomerIndexStats/date": date +"/cloudsearch:v1/CustomerIndexStats/itemCountByStatus": item_count_by_status +"/cloudsearch:v1/CustomerIndexStats/itemCountByStatus/item_count_by_status": item_count_by_status +"/cloudsearch:v1/DataSource": data_source +"/cloudsearch:v1/DataSource/disableModifications": disable_modifications +"/cloudsearch:v1/DataSource/disableServing": disable_serving +"/cloudsearch:v1/DataSource/displayName": display_name +"/cloudsearch:v1/DataSource/indexingServiceAccounts": indexing_service_accounts +"/cloudsearch:v1/DataSource/indexingServiceAccounts/indexing_service_account": indexing_service_account +"/cloudsearch:v1/DataSource/itemsVisibility": items_visibility +"/cloudsearch:v1/DataSource/itemsVisibility/items_visibility": items_visibility +"/cloudsearch:v1/DataSource/name": name +"/cloudsearch:v1/DataSource/operationIds": operation_ids +"/cloudsearch:v1/DataSource/operationIds/operation_id": operation_id +"/cloudsearch:v1/DataSource/shortName": short_name +"/cloudsearch:v1/DataSourceIndexStats": data_source_index_stats +"/cloudsearch:v1/DataSourceIndexStats/date": date +"/cloudsearch:v1/DataSourceIndexStats/itemCountByStatus": item_count_by_status +"/cloudsearch:v1/DataSourceIndexStats/itemCountByStatus/item_count_by_status": item_count_by_status +"/cloudsearch:v1/DataSourceRestriction": data_source_restriction +"/cloudsearch:v1/DataSourceRestriction/filterOptions": filter_options +"/cloudsearch:v1/DataSourceRestriction/filterOptions/filter_option": filter_option +"/cloudsearch:v1/DataSourceRestriction/source": source +"/cloudsearch:v1/Date": date +"/cloudsearch:v1/Date/day": day +"/cloudsearch:v1/Date/month": month +"/cloudsearch:v1/Date/year": year +"/cloudsearch:v1/DateOperatorOptions": date_operator_options +"/cloudsearch:v1/DateOperatorOptions/greaterThanOperatorName": greater_than_operator_name +"/cloudsearch:v1/DateOperatorOptions/lessThanOperatorName": less_than_operator_name +"/cloudsearch:v1/DateOperatorOptions/operatorName": operator_name +"/cloudsearch:v1/DatePropertyOptions": date_property_options +"/cloudsearch:v1/DatePropertyOptions/operatorOptions": operator_options +"/cloudsearch:v1/DateValues": date_values +"/cloudsearch:v1/DateValues/values": values +"/cloudsearch:v1/DateValues/values/value": value +"/cloudsearch:v1/DebugOptions": debug_options +"/cloudsearch:v1/DebugOptions/enableDebugging": enable_debugging +"/cloudsearch:v1/DeleteQueueItemsRequest": delete_queue_items_request +"/cloudsearch:v1/DeleteQueueItemsRequest/connectorName": connector_name +"/cloudsearch:v1/DeleteQueueItemsRequest/debugOptions": debug_options +"/cloudsearch:v1/DeleteQueueItemsRequest/queue": queue +"/cloudsearch:v1/DisplayedProperty": displayed_property +"/cloudsearch:v1/DisplayedProperty/propertyName": property_name +"/cloudsearch:v1/DoubleOperatorOptions": double_operator_options +"/cloudsearch:v1/DoubleOperatorOptions/operatorName": operator_name +"/cloudsearch:v1/DoublePropertyOptions": double_property_options +"/cloudsearch:v1/DoublePropertyOptions/operatorOptions": operator_options +"/cloudsearch:v1/DoubleValues": double_values +"/cloudsearch:v1/DoubleValues/values": values +"/cloudsearch:v1/DoubleValues/values/value": value +"/cloudsearch:v1/DriveFollowUpRestrict": drive_follow_up_restrict +"/cloudsearch:v1/DriveFollowUpRestrict/type": type +"/cloudsearch:v1/DriveLocationRestrict": drive_location_restrict +"/cloudsearch:v1/DriveLocationRestrict/type": type +"/cloudsearch:v1/DriveMimeTypeRestrict": drive_mime_type_restrict +"/cloudsearch:v1/DriveMimeTypeRestrict/type": type +"/cloudsearch:v1/DriveTimeSpanRestrict": drive_time_span_restrict +"/cloudsearch:v1/DriveTimeSpanRestrict/type": type +"/cloudsearch:v1/EmailAddress": email_address +"/cloudsearch:v1/EmailAddress/emailAddress": email_address +"/cloudsearch:v1/EnumOperatorOptions": enum_operator_options +"/cloudsearch:v1/EnumOperatorOptions/operatorName": operator_name +"/cloudsearch:v1/EnumPropertyOptions": enum_property_options +"/cloudsearch:v1/EnumPropertyOptions/operatorOptions": operator_options +"/cloudsearch:v1/EnumPropertyOptions/orderedRanking": ordered_ranking +"/cloudsearch:v1/EnumPropertyOptions/possibleValues": possible_values +"/cloudsearch:v1/EnumPropertyOptions/possibleValues/possible_value": possible_value +"/cloudsearch:v1/EnumValuePair": enum_value_pair +"/cloudsearch:v1/EnumValuePair/integerValue": integer_value +"/cloudsearch:v1/EnumValuePair/stringValue": string_value +"/cloudsearch:v1/EnumValues": enum_values +"/cloudsearch:v1/EnumValues/values": values +"/cloudsearch:v1/EnumValues/values/value": value +"/cloudsearch:v1/ErrorInfo": error_info +"/cloudsearch:v1/ErrorInfo/errorMessages": error_messages +"/cloudsearch:v1/ErrorInfo/errorMessages/error_message": error_message +"/cloudsearch:v1/ErrorMessage": error_message +"/cloudsearch:v1/ErrorMessage/errorMessage": error_message +"/cloudsearch:v1/ErrorMessage/source": source +"/cloudsearch:v1/FacetBucket": facet_bucket +"/cloudsearch:v1/FacetBucket/count": count +"/cloudsearch:v1/FacetBucket/percentage": percentage +"/cloudsearch:v1/FacetBucket/value": value +"/cloudsearch:v1/FacetOptions": facet_options +"/cloudsearch:v1/FacetOptions/objectType": object_type +"/cloudsearch:v1/FacetOptions/operatorName": operator_name +"/cloudsearch:v1/FacetOptions/sourceName": source_name +"/cloudsearch:v1/FacetResult": facet_result +"/cloudsearch:v1/FacetResult/buckets": buckets +"/cloudsearch:v1/FacetResult/buckets/bucket": bucket +"/cloudsearch:v1/FacetResult/objectType": object_type +"/cloudsearch:v1/FacetResult/operatorName": operator_name +"/cloudsearch:v1/FacetResult/sourceName": source_name +"/cloudsearch:v1/FieldViolation": field_violation +"/cloudsearch:v1/FieldViolation/description": description +"/cloudsearch:v1/FieldViolation/field": field +"/cloudsearch:v1/Filter": filter +"/cloudsearch:v1/Filter/compositeFilter": composite_filter +"/cloudsearch:v1/Filter/valueFilter": value_filter +"/cloudsearch:v1/FilterOptions": filter_options +"/cloudsearch:v1/FilterOptions/filter": filter +"/cloudsearch:v1/FilterOptions/objectType": object_type +"/cloudsearch:v1/FreshnessOptions": freshness_options +"/cloudsearch:v1/FreshnessOptions/freshnessDuration": freshness_duration +"/cloudsearch:v1/FreshnessOptions/freshnessProperty": freshness_property +"/cloudsearch:v1/GSuitePrincipal": g_suite_principal +"/cloudsearch:v1/GSuitePrincipal/gsuiteDomain": gsuite_domain +"/cloudsearch:v1/GSuitePrincipal/gsuiteGroupEmail": gsuite_group_email +"/cloudsearch:v1/GSuitePrincipal/gsuiteUserEmail": gsuite_user_email +"/cloudsearch:v1/GetCustomerIndexStatsResponse": get_customer_index_stats_response +"/cloudsearch:v1/GetCustomerIndexStatsResponse/stats": stats +"/cloudsearch:v1/GetCustomerIndexStatsResponse/stats/stat": stat +"/cloudsearch:v1/GetDataSourceIndexStatsResponse": get_data_source_index_stats_response +"/cloudsearch:v1/GetDataSourceIndexStatsResponse/stats": stats +"/cloudsearch:v1/GetDataSourceIndexStatsResponse/stats/stat": stat +"/cloudsearch:v1/HtmlOperatorOptions": html_operator_options +"/cloudsearch:v1/HtmlOperatorOptions/operatorName": operator_name +"/cloudsearch:v1/HtmlPropertyOptions": html_property_options +"/cloudsearch:v1/HtmlPropertyOptions/operatorOptions": operator_options +"/cloudsearch:v1/HtmlPropertyOptions/retrievalImportance": retrieval_importance +"/cloudsearch:v1/HtmlValues": html_values +"/cloudsearch:v1/HtmlValues/values": values +"/cloudsearch:v1/HtmlValues/values/value": value +"/cloudsearch:v1/IndexItemRequest": index_item_request +"/cloudsearch:v1/IndexItemRequest/connectorName": connector_name +"/cloudsearch:v1/IndexItemRequest/debugOptions": debug_options +"/cloudsearch:v1/IndexItemRequest/item": item +"/cloudsearch:v1/IndexItemRequest/mode": mode +"/cloudsearch:v1/IntegerOperatorOptions": integer_operator_options +"/cloudsearch:v1/IntegerOperatorOptions/greaterThanOperatorName": greater_than_operator_name +"/cloudsearch:v1/IntegerOperatorOptions/lessThanOperatorName": less_than_operator_name +"/cloudsearch:v1/IntegerOperatorOptions/operatorName": operator_name +"/cloudsearch:v1/IntegerPropertyOptions": integer_property_options +"/cloudsearch:v1/IntegerPropertyOptions/maximumValue": maximum_value +"/cloudsearch:v1/IntegerPropertyOptions/minimumValue": minimum_value +"/cloudsearch:v1/IntegerPropertyOptions/operatorOptions": operator_options +"/cloudsearch:v1/IntegerPropertyOptions/orderedRanking": ordered_ranking +"/cloudsearch:v1/IntegerValues": integer_values +"/cloudsearch:v1/IntegerValues/values": values +"/cloudsearch:v1/IntegerValues/values/value": value +"/cloudsearch:v1/Interaction": interaction +"/cloudsearch:v1/Interaction/interactionTime": interaction_time +"/cloudsearch:v1/Interaction/principal": principal +"/cloudsearch:v1/Interaction/type": type +"/cloudsearch:v1/Item": item +"/cloudsearch:v1/Item/acl": acl +"/cloudsearch:v1/Item/content": content +"/cloudsearch:v1/Item/itemType": item_type +"/cloudsearch:v1/Item/metadata": metadata +"/cloudsearch:v1/Item/name": name +"/cloudsearch:v1/Item/payload": payload +"/cloudsearch:v1/Item/queue": queue +"/cloudsearch:v1/Item/status": status +"/cloudsearch:v1/Item/structuredData": structured_data +"/cloudsearch:v1/Item/version": version +"/cloudsearch:v1/ItemAcl": item_acl +"/cloudsearch:v1/ItemAcl/aclInheritanceType": acl_inheritance_type +"/cloudsearch:v1/ItemAcl/deniedReaders": denied_readers +"/cloudsearch:v1/ItemAcl/deniedReaders/denied_reader": denied_reader +"/cloudsearch:v1/ItemAcl/inheritAclFrom": inherit_acl_from +"/cloudsearch:v1/ItemAcl/owners": owners +"/cloudsearch:v1/ItemAcl/owners/owner": owner +"/cloudsearch:v1/ItemAcl/readers": readers +"/cloudsearch:v1/ItemAcl/readers/reader": reader +"/cloudsearch:v1/ItemContent": item_content +"/cloudsearch:v1/ItemContent/contentDataRef": content_data_ref +"/cloudsearch:v1/ItemContent/contentFormat": content_format +"/cloudsearch:v1/ItemContent/hash": hash_prop +"/cloudsearch:v1/ItemContent/inlineContent": inline_content +"/cloudsearch:v1/ItemCountByStatus": item_count_by_status +"/cloudsearch:v1/ItemCountByStatus/count": count +"/cloudsearch:v1/ItemCountByStatus/statusCode": status_code +"/cloudsearch:v1/ItemMetadata": item_metadata +"/cloudsearch:v1/ItemMetadata/containerName": container_name +"/cloudsearch:v1/ItemMetadata/contentLanguage": content_language +"/cloudsearch:v1/ItemMetadata/createTime": create_time +"/cloudsearch:v1/ItemMetadata/hash": hash_prop +"/cloudsearch:v1/ItemMetadata/interactions": interactions +"/cloudsearch:v1/ItemMetadata/interactions/interaction": interaction +"/cloudsearch:v1/ItemMetadata/keywords": keywords +"/cloudsearch:v1/ItemMetadata/keywords/keyword": keyword +"/cloudsearch:v1/ItemMetadata/mimeType": mime_type +"/cloudsearch:v1/ItemMetadata/objectType": object_type +"/cloudsearch:v1/ItemMetadata/searchQualityMetadata": search_quality_metadata +"/cloudsearch:v1/ItemMetadata/sourceRepositoryUrl": source_repository_url +"/cloudsearch:v1/ItemMetadata/title": title +"/cloudsearch:v1/ItemMetadata/updateTime": update_time +"/cloudsearch:v1/ItemStatus": item_status +"/cloudsearch:v1/ItemStatus/code": code +"/cloudsearch:v1/ItemStatus/processingErrors": processing_errors +"/cloudsearch:v1/ItemStatus/processingErrors/processing_error": processing_error +"/cloudsearch:v1/ItemStatus/repositoryErrors": repository_errors +"/cloudsearch:v1/ItemStatus/repositoryErrors/repository_error": repository_error +"/cloudsearch:v1/ItemStructuredData": item_structured_data +"/cloudsearch:v1/ItemStructuredData/hash": hash_prop +"/cloudsearch:v1/ItemStructuredData/object": object +"/cloudsearch:v1/ListDataSourceResponse": list_data_source_response +"/cloudsearch:v1/ListDataSourceResponse/nextPageToken": next_page_token +"/cloudsearch:v1/ListDataSourceResponse/sources": sources +"/cloudsearch:v1/ListDataSourceResponse/sources/source": source +"/cloudsearch:v1/ListItemNamesForUnmappedIdentityResponse": list_item_names_for_unmapped_identity_response +"/cloudsearch:v1/ListItemNamesForUnmappedIdentityResponse/itemNames": item_names +"/cloudsearch:v1/ListItemNamesForUnmappedIdentityResponse/itemNames/item_name": item_name +"/cloudsearch:v1/ListItemNamesForUnmappedIdentityResponse/nextPageToken": next_page_token +"/cloudsearch:v1/ListItemsResponse": list_items_response +"/cloudsearch:v1/ListItemsResponse/items": items +"/cloudsearch:v1/ListItemsResponse/items/item": item +"/cloudsearch:v1/ListItemsResponse/nextPageToken": next_page_token +"/cloudsearch:v1/ListQuerySourcesResponse": list_query_sources_response +"/cloudsearch:v1/ListQuerySourcesResponse/nextPageToken": next_page_token +"/cloudsearch:v1/ListQuerySourcesResponse/sources": sources +"/cloudsearch:v1/ListQuerySourcesResponse/sources/source": source +"/cloudsearch:v1/ListSearchApplicationsResponse": list_search_applications_response +"/cloudsearch:v1/ListSearchApplicationsResponse/nextPageToken": next_page_token +"/cloudsearch:v1/ListSearchApplicationsResponse/searchApplications": search_applications +"/cloudsearch:v1/ListSearchApplicationsResponse/searchApplications/search_application": search_application +"/cloudsearch:v1/ListUnmappedIdentitiesResponse": list_unmapped_identities_response +"/cloudsearch:v1/ListUnmappedIdentitiesResponse/nextPageToken": next_page_token +"/cloudsearch:v1/ListUnmappedIdentitiesResponse/unmappedIdentities": unmapped_identities +"/cloudsearch:v1/ListUnmappedIdentitiesResponse/unmappedIdentities/unmapped_identity": unmapped_identity +"/cloudsearch:v1/MatchRange": match_range +"/cloudsearch:v1/MatchRange/end": end +"/cloudsearch:v1/MatchRange/start": start +"/cloudsearch:v1/Media": media +"/cloudsearch:v1/Media/resourceName": resource_name +"/cloudsearch:v1/Metadata": metadata +"/cloudsearch:v1/Metadata/createTime": create_time +"/cloudsearch:v1/Metadata/displayOptions": display_options +"/cloudsearch:v1/Metadata/fields": fields +"/cloudsearch:v1/Metadata/fields/field": field +"/cloudsearch:v1/Metadata/mimeType": mime_type +"/cloudsearch:v1/Metadata/objectType": object_type +"/cloudsearch:v1/Metadata/owner": owner +"/cloudsearch:v1/Metadata/source": source +"/cloudsearch:v1/Metadata/updateTime": update_time +"/cloudsearch:v1/Metaline": metaline +"/cloudsearch:v1/Metaline/properties": properties +"/cloudsearch:v1/Metaline/properties/property": property +"/cloudsearch:v1/Name": name +"/cloudsearch:v1/Name/displayName": display_name +"/cloudsearch:v1/NamedProperty": named_property +"/cloudsearch:v1/NamedProperty/booleanValue": boolean_value +"/cloudsearch:v1/NamedProperty/dateValues": date_values +"/cloudsearch:v1/NamedProperty/doubleValues": double_values +"/cloudsearch:v1/NamedProperty/enumValues": enum_values +"/cloudsearch:v1/NamedProperty/htmlValues": html_values +"/cloudsearch:v1/NamedProperty/integerValues": integer_values +"/cloudsearch:v1/NamedProperty/name": name +"/cloudsearch:v1/NamedProperty/objectValues": object_values +"/cloudsearch:v1/NamedProperty/textValues": text_values +"/cloudsearch:v1/NamedProperty/timestampValues": timestamp_values +"/cloudsearch:v1/ObjectDefinition": object_definition +"/cloudsearch:v1/ObjectDefinition/name": name +"/cloudsearch:v1/ObjectDefinition/options": options +"/cloudsearch:v1/ObjectDefinition/propertyDefinitions": property_definitions +"/cloudsearch:v1/ObjectDefinition/propertyDefinitions/property_definition": property_definition +"/cloudsearch:v1/ObjectDisplayOptions": object_display_options +"/cloudsearch:v1/ObjectDisplayOptions/metalines": metalines +"/cloudsearch:v1/ObjectDisplayOptions/metalines/metaline": metaline +"/cloudsearch:v1/ObjectDisplayOptions/objectDisplayLabel": object_display_label +"/cloudsearch:v1/ObjectOptions": object_options +"/cloudsearch:v1/ObjectOptions/displayOptions": display_options +"/cloudsearch:v1/ObjectOptions/freshnessOptions": freshness_options +"/cloudsearch:v1/ObjectPropertyOptions": object_property_options +"/cloudsearch:v1/ObjectPropertyOptions/subobjectProperties": subobject_properties +"/cloudsearch:v1/ObjectPropertyOptions/subobjectProperties/subobject_property": subobject_property +"/cloudsearch:v1/ObjectValues": object_values +"/cloudsearch:v1/ObjectValues/values": values +"/cloudsearch:v1/ObjectValues/values/value": value +"/cloudsearch:v1/Operation": operation +"/cloudsearch:v1/Operation/done": done +"/cloudsearch:v1/Operation/error": error +"/cloudsearch:v1/Operation/metadata": metadata +"/cloudsearch:v1/Operation/metadata/metadatum": metadatum +"/cloudsearch:v1/Operation/name": name +"/cloudsearch:v1/Operation/response": response +"/cloudsearch:v1/Operation/response/response": response +"/cloudsearch:v1/PeopleSuggestion": people_suggestion +"/cloudsearch:v1/PeopleSuggestion/person": person +"/cloudsearch:v1/Person": person +"/cloudsearch:v1/Person/emailAddresses": email_addresses +"/cloudsearch:v1/Person/emailAddresses/email_address": email_address +"/cloudsearch:v1/Person/name": name +"/cloudsearch:v1/Person/obfuscatedId": obfuscated_id +"/cloudsearch:v1/Person/personNames": person_names +"/cloudsearch:v1/Person/personNames/person_name": person_name +"/cloudsearch:v1/Person/photos": photos +"/cloudsearch:v1/Person/photos/photo": photo +"/cloudsearch:v1/Photo": photo +"/cloudsearch:v1/Photo/url": url +"/cloudsearch:v1/PollItemsRequest": poll_items_request +"/cloudsearch:v1/PollItemsRequest/connectorName": connector_name +"/cloudsearch:v1/PollItemsRequest/debugOptions": debug_options +"/cloudsearch:v1/PollItemsRequest/limit": limit +"/cloudsearch:v1/PollItemsRequest/queue": queue +"/cloudsearch:v1/PollItemsRequest/statusCodes": status_codes +"/cloudsearch:v1/PollItemsRequest/statusCodes/status_code": status_code +"/cloudsearch:v1/PollItemsResponse": poll_items_response +"/cloudsearch:v1/PollItemsResponse/items": items +"/cloudsearch:v1/PollItemsResponse/items/item": item +"/cloudsearch:v1/Principal": principal +"/cloudsearch:v1/Principal/groupResourceName": group_resource_name +"/cloudsearch:v1/Principal/gsuitePrincipal": gsuite_principal +"/cloudsearch:v1/Principal/userResourceName": user_resource_name +"/cloudsearch:v1/ProcessingError": processing_error +"/cloudsearch:v1/ProcessingError/code": code +"/cloudsearch:v1/ProcessingError/errorMessage": error_message +"/cloudsearch:v1/ProcessingError/fieldViolations": field_violations +"/cloudsearch:v1/ProcessingError/fieldViolations/field_violation": field_violation +"/cloudsearch:v1/PropertyDefinition": property_definition +"/cloudsearch:v1/PropertyDefinition/booleanPropertyOptions": boolean_property_options +"/cloudsearch:v1/PropertyDefinition/datePropertyOptions": date_property_options +"/cloudsearch:v1/PropertyDefinition/displayOptions": display_options +"/cloudsearch:v1/PropertyDefinition/doublePropertyOptions": double_property_options +"/cloudsearch:v1/PropertyDefinition/enumPropertyOptions": enum_property_options +"/cloudsearch:v1/PropertyDefinition/htmlPropertyOptions": html_property_options +"/cloudsearch:v1/PropertyDefinition/integerPropertyOptions": integer_property_options +"/cloudsearch:v1/PropertyDefinition/isFacetable": is_facetable +"/cloudsearch:v1/PropertyDefinition/isRepeatable": is_repeatable +"/cloudsearch:v1/PropertyDefinition/isReturnable": is_returnable +"/cloudsearch:v1/PropertyDefinition/isSortable": is_sortable +"/cloudsearch:v1/PropertyDefinition/name": name +"/cloudsearch:v1/PropertyDefinition/objectPropertyOptions": object_property_options +"/cloudsearch:v1/PropertyDefinition/textPropertyOptions": text_property_options +"/cloudsearch:v1/PropertyDefinition/timestampPropertyOptions": timestamp_property_options +"/cloudsearch:v1/PropertyDisplayOptions": property_display_options +"/cloudsearch:v1/PropertyDisplayOptions/displayLabel": display_label +"/cloudsearch:v1/PushItem": push_item +"/cloudsearch:v1/PushItem/contentHash": content_hash +"/cloudsearch:v1/PushItem/metadataHash": metadata_hash +"/cloudsearch:v1/PushItem/payload": payload +"/cloudsearch:v1/PushItem/queue": queue +"/cloudsearch:v1/PushItem/repositoryError": repository_error +"/cloudsearch:v1/PushItem/structuredDataHash": structured_data_hash +"/cloudsearch:v1/PushItem/type": type +"/cloudsearch:v1/PushItemRequest": push_item_request +"/cloudsearch:v1/PushItemRequest/connectorName": connector_name +"/cloudsearch:v1/PushItemRequest/debugOptions": debug_options +"/cloudsearch:v1/PushItemRequest/item": item +"/cloudsearch:v1/QueryInterpretation": query_interpretation +"/cloudsearch:v1/QueryInterpretation/interpretationType": interpretation_type +"/cloudsearch:v1/QueryInterpretation/interpretedQuery": interpreted_query +"/cloudsearch:v1/QueryInterpretationOptions": query_interpretation_options +"/cloudsearch:v1/QueryInterpretationOptions/disableNlInterpretation": disable_nl_interpretation +"/cloudsearch:v1/QueryItem": query_item +"/cloudsearch:v1/QueryItem/isSynthetic": is_synthetic +"/cloudsearch:v1/QueryOperator": query_operator +"/cloudsearch:v1/QueryOperator/displayName": display_name +"/cloudsearch:v1/QueryOperator/enumValues": enum_values +"/cloudsearch:v1/QueryOperator/enumValues/enum_value": enum_value +"/cloudsearch:v1/QueryOperator/greaterThanOperatorName": greater_than_operator_name +"/cloudsearch:v1/QueryOperator/isFacetable": is_facetable +"/cloudsearch:v1/QueryOperator/isRepeatable": is_repeatable +"/cloudsearch:v1/QueryOperator/isReturnable": is_returnable +"/cloudsearch:v1/QueryOperator/isSortable": is_sortable +"/cloudsearch:v1/QueryOperator/isSuggestable": is_suggestable +"/cloudsearch:v1/QueryOperator/lessThanOperatorName": less_than_operator_name +"/cloudsearch:v1/QueryOperator/operatorName": operator_name +"/cloudsearch:v1/QueryOperator/type": type +"/cloudsearch:v1/QuerySource": query_source +"/cloudsearch:v1/QuerySource/displayName": display_name +"/cloudsearch:v1/QuerySource/operators": operators +"/cloudsearch:v1/QuerySource/operators/operator": operator +"/cloudsearch:v1/QuerySource/shortName": short_name +"/cloudsearch:v1/QuerySource/source": source +"/cloudsearch:v1/QuerySuggestion": query_suggestion +"/cloudsearch:v1/RepositoryError": repository_error +"/cloudsearch:v1/RepositoryError/errorMessage": error_message +"/cloudsearch:v1/RepositoryError/httpStatusCode": http_status_code +"/cloudsearch:v1/RepositoryError/type": type +"/cloudsearch:v1/RequestOptions": request_options +"/cloudsearch:v1/RequestOptions/debugOptions": debug_options +"/cloudsearch:v1/RequestOptions/languageCode": language_code +"/cloudsearch:v1/RequestOptions/searchApplicationId": search_application_id +"/cloudsearch:v1/RequestOptions/timeZone": time_zone +"/cloudsearch:v1/ResetSearchApplicationRequest": reset_search_application_request +"/cloudsearch:v1/ResetSearchApplicationRequest/debugOptions": debug_options +"/cloudsearch:v1/ResponseDebugInfo": response_debug_info +"/cloudsearch:v1/ResponseDebugInfo/formattedDebugInfo": formatted_debug_info +"/cloudsearch:v1/RestrictItem": restrict_item +"/cloudsearch:v1/RestrictItem/driveFollowUpRestrict": drive_follow_up_restrict +"/cloudsearch:v1/RestrictItem/driveLocationRestrict": drive_location_restrict +"/cloudsearch:v1/RestrictItem/driveMimeTypeRestrict": drive_mime_type_restrict +"/cloudsearch:v1/RestrictItem/driveTimeSpanRestrict": drive_time_span_restrict +"/cloudsearch:v1/RestrictItem/searchOperator": search_operator +"/cloudsearch:v1/ResultCounts": result_counts +"/cloudsearch:v1/ResultCounts/sourceResultCounts": source_result_counts +"/cloudsearch:v1/ResultCounts/sourceResultCounts/source_result_count": source_result_count +"/cloudsearch:v1/ResultDebugInfo": result_debug_info +"/cloudsearch:v1/ResultDebugInfo/formattedDebugInfo": formatted_debug_info +"/cloudsearch:v1/ResultDisplayField": result_display_field +"/cloudsearch:v1/ResultDisplayField/label": label +"/cloudsearch:v1/ResultDisplayField/operatorName": operator_name +"/cloudsearch:v1/ResultDisplayField/property": property +"/cloudsearch:v1/ResultDisplayLine": result_display_line +"/cloudsearch:v1/ResultDisplayLine/fields": fields +"/cloudsearch:v1/ResultDisplayLine/fields/field": field +"/cloudsearch:v1/ResultDisplayMetadata": result_display_metadata +"/cloudsearch:v1/ResultDisplayMetadata/metalines": metalines +"/cloudsearch:v1/ResultDisplayMetadata/metalines/metaline": metaline +"/cloudsearch:v1/ResultDisplayMetadata/objectTypeLabel": object_type_label +"/cloudsearch:v1/RetrievalImportance": retrieval_importance +"/cloudsearch:v1/RetrievalImportance/importance": importance +"/cloudsearch:v1/Schema": schema +"/cloudsearch:v1/Schema/objectDefinitions": object_definitions +"/cloudsearch:v1/Schema/objectDefinitions/object_definition": object_definition +"/cloudsearch:v1/Schema/operationIds": operation_ids +"/cloudsearch:v1/Schema/operationIds/operation_id": operation_id +"/cloudsearch:v1/ScoringConfig": scoring_config +"/cloudsearch:v1/ScoringConfig/disableFreshness": disable_freshness +"/cloudsearch:v1/ScoringConfig/disablePersonalization": disable_personalization +"/cloudsearch:v1/SearchApplication": search_application +"/cloudsearch:v1/SearchApplication/dataSourceRestrictions": data_source_restrictions +"/cloudsearch:v1/SearchApplication/dataSourceRestrictions/data_source_restriction": data_source_restriction +"/cloudsearch:v1/SearchApplication/defaultFacetOptions": default_facet_options +"/cloudsearch:v1/SearchApplication/defaultFacetOptions/default_facet_option": default_facet_option +"/cloudsearch:v1/SearchApplication/defaultSortOptions": default_sort_options +"/cloudsearch:v1/SearchApplication/displayName": display_name +"/cloudsearch:v1/SearchApplication/name": name +"/cloudsearch:v1/SearchApplication/operationIds": operation_ids +"/cloudsearch:v1/SearchApplication/operationIds/operation_id": operation_id +"/cloudsearch:v1/SearchApplication/scoringConfig": scoring_config +"/cloudsearch:v1/SearchApplication/sourceConfig": source_config +"/cloudsearch:v1/SearchApplication/sourceConfig/source_config": source_config +"/cloudsearch:v1/SearchQualityMetadata": search_quality_metadata +"/cloudsearch:v1/SearchQualityMetadata/quality": quality +"/cloudsearch:v1/SearchRequest": search_request +"/cloudsearch:v1/SearchRequest/dataSourceRestrictions": data_source_restrictions +"/cloudsearch:v1/SearchRequest/dataSourceRestrictions/data_source_restriction": data_source_restriction +"/cloudsearch:v1/SearchRequest/facetOptions": facet_options +"/cloudsearch:v1/SearchRequest/facetOptions/facet_option": facet_option +"/cloudsearch:v1/SearchRequest/pageSize": page_size +"/cloudsearch:v1/SearchRequest/query": query +"/cloudsearch:v1/SearchRequest/queryInterpretationOptions": query_interpretation_options +"/cloudsearch:v1/SearchRequest/requestOptions": request_options +"/cloudsearch:v1/SearchRequest/sortOptions": sort_options +"/cloudsearch:v1/SearchRequest/start": start +"/cloudsearch:v1/SearchResponse": search_response +"/cloudsearch:v1/SearchResponse/debugInfo": debug_info +"/cloudsearch:v1/SearchResponse/errorInfo": error_info +"/cloudsearch:v1/SearchResponse/facetResults": facet_results +"/cloudsearch:v1/SearchResponse/facetResults/facet_result": facet_result +"/cloudsearch:v1/SearchResponse/hasMoreResults": has_more_results +"/cloudsearch:v1/SearchResponse/queryInterpretation": query_interpretation +"/cloudsearch:v1/SearchResponse/resultCountEstimate": result_count_estimate +"/cloudsearch:v1/SearchResponse/resultCountExact": result_count_exact +"/cloudsearch:v1/SearchResponse/resultCounts": result_counts +"/cloudsearch:v1/SearchResponse/results": results +"/cloudsearch:v1/SearchResponse/results/result": result +"/cloudsearch:v1/SearchResponse/spellResults": spell_results +"/cloudsearch:v1/SearchResponse/spellResults/spell_result": spell_result +"/cloudsearch:v1/SearchResponse/structuredResults": structured_results +"/cloudsearch:v1/SearchResponse/structuredResults/structured_result": structured_result +"/cloudsearch:v1/SearchResult": search_result +"/cloudsearch:v1/SearchResult/clusteredResults": clustered_results +"/cloudsearch:v1/SearchResult/clusteredResults/clustered_result": clustered_result +"/cloudsearch:v1/SearchResult/debugInfo": debug_info +"/cloudsearch:v1/SearchResult/metadata": metadata +"/cloudsearch:v1/SearchResult/snippet": snippet +"/cloudsearch:v1/SearchResult/title": title +"/cloudsearch:v1/SearchResult/url": url +"/cloudsearch:v1/Snippet": snippet +"/cloudsearch:v1/Snippet/matchRanges": match_ranges +"/cloudsearch:v1/Snippet/matchRanges/match_range": match_range +"/cloudsearch:v1/Snippet/snippet": snippet +"/cloudsearch:v1/SortOptions": sort_options +"/cloudsearch:v1/SortOptions/operatorName": operator_name +"/cloudsearch:v1/SortOptions/sortOrder": sort_order +"/cloudsearch:v1/Source": source +"/cloudsearch:v1/Source/name": name +"/cloudsearch:v1/Source/predefinedSource": predefined_source +"/cloudsearch:v1/SourceConfig": source_config +"/cloudsearch:v1/SourceConfig/crowdingConfig": crowding_config +"/cloudsearch:v1/SourceConfig/scoringConfig": scoring_config +"/cloudsearch:v1/SourceConfig/source": source +"/cloudsearch:v1/SourceCrowdingConfig": source_crowding_config +"/cloudsearch:v1/SourceCrowdingConfig/field": field +"/cloudsearch:v1/SourceCrowdingConfig/numResults": num_results +"/cloudsearch:v1/SourceCrowdingConfig/numSuggestions": num_suggestions +"/cloudsearch:v1/SourceCrowdingConfig/source": source +"/cloudsearch:v1/SourceResultCount": source_result_count +"/cloudsearch:v1/SourceResultCount/hasMoreResults": has_more_results +"/cloudsearch:v1/SourceResultCount/resultCountEstimate": result_count_estimate +"/cloudsearch:v1/SourceResultCount/resultCountExact": result_count_exact +"/cloudsearch:v1/SourceResultCount/source": source +"/cloudsearch:v1/SourceScoringConfig": source_scoring_config +"/cloudsearch:v1/SourceScoringConfig/sourceImportance": source_importance +"/cloudsearch:v1/SpellResult": spell_result +"/cloudsearch:v1/SpellResult/suggestedQuery": suggested_query +"/cloudsearch:v1/StartUploadItemRequest": start_upload_item_request +"/cloudsearch:v1/StartUploadItemRequest/connectorName": connector_name +"/cloudsearch:v1/StartUploadItemRequest/debugOptions": debug_options +"/cloudsearch:v1/Status": status +"/cloudsearch:v1/Status/code": code +"/cloudsearch:v1/Status/details": details +"/cloudsearch:v1/Status/details/detail": detail +"/cloudsearch:v1/Status/details/detail/detail": detail +"/cloudsearch:v1/Status/message": message +"/cloudsearch:v1/StructuredDataObject": structured_data_object +"/cloudsearch:v1/StructuredDataObject/properties": properties +"/cloudsearch:v1/StructuredDataObject/properties/property": property +"/cloudsearch:v1/StructuredResult": structured_result +"/cloudsearch:v1/StructuredResult/person": person +"/cloudsearch:v1/SuggestRequest": suggest_request +"/cloudsearch:v1/SuggestRequest/dataSourceRestrictions": data_source_restrictions +"/cloudsearch:v1/SuggestRequest/dataSourceRestrictions/data_source_restriction": data_source_restriction +"/cloudsearch:v1/SuggestRequest/query": query +"/cloudsearch:v1/SuggestRequest/requestOptions": request_options +"/cloudsearch:v1/SuggestResponse": suggest_response +"/cloudsearch:v1/SuggestResponse/suggestResults": suggest_results +"/cloudsearch:v1/SuggestResponse/suggestResults/suggest_result": suggest_result +"/cloudsearch:v1/SuggestResult": suggest_result +"/cloudsearch:v1/SuggestResult/peopleSuggestion": people_suggestion +"/cloudsearch:v1/SuggestResult/querySuggestion": query_suggestion +"/cloudsearch:v1/SuggestResult/source": source +"/cloudsearch:v1/SuggestResult/suggestedQuery": suggested_query +"/cloudsearch:v1/TextOperatorOptions": text_operator_options +"/cloudsearch:v1/TextOperatorOptions/exactMatchWithOperator": exact_match_with_operator +"/cloudsearch:v1/TextOperatorOptions/operatorName": operator_name +"/cloudsearch:v1/TextPropertyOptions": text_property_options +"/cloudsearch:v1/TextPropertyOptions/operatorOptions": operator_options +"/cloudsearch:v1/TextPropertyOptions/retrievalImportance": retrieval_importance +"/cloudsearch:v1/TextValues": text_values +"/cloudsearch:v1/TextValues/values": values +"/cloudsearch:v1/TextValues/values/value": value +"/cloudsearch:v1/TimestampOperatorOptions": timestamp_operator_options +"/cloudsearch:v1/TimestampOperatorOptions/greaterThanOperatorName": greater_than_operator_name +"/cloudsearch:v1/TimestampOperatorOptions/lessThanOperatorName": less_than_operator_name +"/cloudsearch:v1/TimestampOperatorOptions/operatorName": operator_name +"/cloudsearch:v1/TimestampPropertyOptions": timestamp_property_options +"/cloudsearch:v1/TimestampPropertyOptions/operatorOptions": operator_options +"/cloudsearch:v1/TimestampValues": timestamp_values +"/cloudsearch:v1/TimestampValues/values": values +"/cloudsearch:v1/TimestampValues/values/value": value +"/cloudsearch:v1/UnmappedIdentity": unmapped_identity +"/cloudsearch:v1/UnmappedIdentity/externalIdentity": external_identity +"/cloudsearch:v1/UnmappedIdentity/resolutionStatusCode": resolution_status_code +"/cloudsearch:v1/UnreserveItemsRequest": unreserve_items_request +"/cloudsearch:v1/UnreserveItemsRequest/connectorName": connector_name +"/cloudsearch:v1/UnreserveItemsRequest/debugOptions": debug_options +"/cloudsearch:v1/UnreserveItemsRequest/queue": queue +"/cloudsearch:v1/UpdateDataSourceRequest": update_data_source_request +"/cloudsearch:v1/UpdateDataSourceRequest/debugOptions": debug_options +"/cloudsearch:v1/UpdateDataSourceRequest/source": source +"/cloudsearch:v1/UpdateSchemaRequest": update_schema_request +"/cloudsearch:v1/UpdateSchemaRequest/debugOptions": debug_options +"/cloudsearch:v1/UpdateSchemaRequest/schema": schema +"/cloudsearch:v1/UpdateSchemaRequest/validateOnly": validate_only +"/cloudsearch:v1/UploadItemRef": upload_item_ref +"/cloudsearch:v1/UploadItemRef/name": name +"/cloudsearch:v1/Value": value +"/cloudsearch:v1/Value/booleanValue": boolean_value +"/cloudsearch:v1/Value/dateValue": date_value +"/cloudsearch:v1/Value/doubleValue": double_value +"/cloudsearch:v1/Value/integerValue": integer_value +"/cloudsearch:v1/Value/stringValue": string_value +"/cloudsearch:v1/Value/timestampValue": timestamp_value +"/cloudsearch:v1/ValueFilter": value_filter +"/cloudsearch:v1/ValueFilter/operatorName": operator_name +"/cloudsearch:v1/ValueFilter/value": value +"/cloudsearch:v1/cloudsearch.debug.datasources.items.unmappedids.list": list_debug_datasource_item_unmappedids +"/cloudsearch:v1/cloudsearch.debug.datasources.items.unmappedids.list/pageSize": page_size +"/cloudsearch:v1/cloudsearch.debug.datasources.items.unmappedids.list/pageToken": page_token +"/cloudsearch:v1/cloudsearch.debug.datasources.items.unmappedids.list/parent": parent +"/cloudsearch:v1/cloudsearch.debug.identitysources.items.listForunmappedidentity": list_debug_identitysource_item_forunmappedidentity +"/cloudsearch:v1/cloudsearch.debug.identitysources.items.listForunmappedidentity/groupResourceName": group_resource_name +"/cloudsearch:v1/cloudsearch.debug.identitysources.items.listForunmappedidentity/pageSize": page_size +"/cloudsearch:v1/cloudsearch.debug.identitysources.items.listForunmappedidentity/pageToken": page_token +"/cloudsearch:v1/cloudsearch.debug.identitysources.items.listForunmappedidentity/parent": parent +"/cloudsearch:v1/cloudsearch.debug.identitysources.items.listForunmappedidentity/userResourceName": user_resource_name +"/cloudsearch:v1/cloudsearch.debug.identitysources.unmappedids.list": list_debug_identitysource_unmappedids +"/cloudsearch:v1/cloudsearch.debug.identitysources.unmappedids.list/pageSize": page_size +"/cloudsearch:v1/cloudsearch.debug.identitysources.unmappedids.list/pageToken": page_token +"/cloudsearch:v1/cloudsearch.debug.identitysources.unmappedids.list/parent": parent +"/cloudsearch:v1/cloudsearch.debug.identitysources.unmappedids.list/resolutionStatusCode": resolution_status_code +"/cloudsearch:v1/cloudsearch.indexing.datasources.deleteSchema": delete_indexing_datasource_schema +"/cloudsearch:v1/cloudsearch.indexing.datasources.deleteSchema/debugOptions.enableDebugging": debug_options_enable_debugging +"/cloudsearch:v1/cloudsearch.indexing.datasources.deleteSchema/name": name +"/cloudsearch:v1/cloudsearch.indexing.datasources.getSchema": get_indexing_datasource_schema +"/cloudsearch:v1/cloudsearch.indexing.datasources.getSchema/debugOptions.enableDebugging": debug_options_enable_debugging +"/cloudsearch:v1/cloudsearch.indexing.datasources.getSchema/name": name +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.delete": delete_indexing_datasource_item +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.delete/connectorName": connector_name +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.delete/debugOptions.enableDebugging": debug_options_enable_debugging +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.delete/mode": mode +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.delete/name": name +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.delete/version": version +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.deleteQueueItems": delete_queue_items +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.deleteQueueItems/name": name +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.get": get_indexing_datasource_item +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.get/connectorName": connector_name +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.get/debugOptions.enableDebugging": debug_options_enable_debugging +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.get/name": name +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.index": index_item +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.index/name": name +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.list": list_indexing_datasource_items +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.list/brief": brief +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.list/connectorName": connector_name +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.list/debugOptions.enableDebugging": debug_options_enable_debugging +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.list/name": name +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.list/pageSize": page_size +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.list/pageToken": page_token +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.poll": poll_items +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.poll/name": name +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.push": push_item +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.push/name": name +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.unreserve": unreserve_items +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.unreserve/name": name +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.upload": upload_indexing_datasource_item +"/cloudsearch:v1/cloudsearch.indexing.datasources.items.upload/name": name +"/cloudsearch:v1/cloudsearch.indexing.datasources.updateSchema": update_datasource_schema +"/cloudsearch:v1/cloudsearch.indexing.datasources.updateSchema/name": name +"/cloudsearch:v1/cloudsearch.media.upload": upload_medium +"/cloudsearch:v1/cloudsearch.media.upload/resourceName": resource_name +"/cloudsearch:v1/cloudsearch.operations.get": get_operation +"/cloudsearch:v1/cloudsearch.operations.get/name": name +"/cloudsearch:v1/cloudsearch.query.search": search_query +"/cloudsearch:v1/cloudsearch.query.sources.list": list_query_sources +"/cloudsearch:v1/cloudsearch.query.sources.list/pageToken": page_token +"/cloudsearch:v1/cloudsearch.query.sources.list/requestOptions.debugOptions.enableDebugging": request_options_debug_options_enable_debugging +"/cloudsearch:v1/cloudsearch.query.sources.list/requestOptions.languageCode": request_options_language_code +"/cloudsearch:v1/cloudsearch.query.sources.list/requestOptions.searchApplicationId": request_options_search_application_id +"/cloudsearch:v1/cloudsearch.query.sources.list/requestOptions.timeZone": request_options_time_zone +"/cloudsearch:v1/cloudsearch.query.suggest": suggest_query +"/cloudsearch:v1/cloudsearch.settings.datasources.create": create_setting_datasource +"/cloudsearch:v1/cloudsearch.settings.datasources.delete": delete_setting_datasource +"/cloudsearch:v1/cloudsearch.settings.datasources.delete/debugOptions.enableDebugging": debug_options_enable_debugging +"/cloudsearch:v1/cloudsearch.settings.datasources.delete/name": name +"/cloudsearch:v1/cloudsearch.settings.datasources.get": get_setting_datasource +"/cloudsearch:v1/cloudsearch.settings.datasources.get/debugOptions.enableDebugging": debug_options_enable_debugging +"/cloudsearch:v1/cloudsearch.settings.datasources.get/name": name +"/cloudsearch:v1/cloudsearch.settings.datasources.list": list_setting_datasources +"/cloudsearch:v1/cloudsearch.settings.datasources.list/debugOptions.enableDebugging": debug_options_enable_debugging +"/cloudsearch:v1/cloudsearch.settings.datasources.list/pageSize": page_size +"/cloudsearch:v1/cloudsearch.settings.datasources.list/pageToken": page_token +"/cloudsearch:v1/cloudsearch.settings.datasources.update": update_datasource_data_source +"/cloudsearch:v1/cloudsearch.settings.datasources.update/name": name +"/cloudsearch:v1/cloudsearch.settings.searchapplications.create": create_setting_searchapplication +"/cloudsearch:v1/cloudsearch.settings.searchapplications.delete": delete_setting_searchapplication +"/cloudsearch:v1/cloudsearch.settings.searchapplications.delete/debugOptions.enableDebugging": debug_options_enable_debugging +"/cloudsearch:v1/cloudsearch.settings.searchapplications.delete/name": name +"/cloudsearch:v1/cloudsearch.settings.searchapplications.get": get_setting_searchapplication +"/cloudsearch:v1/cloudsearch.settings.searchapplications.get/debugOptions.enableDebugging": debug_options_enable_debugging +"/cloudsearch:v1/cloudsearch.settings.searchapplications.get/name": name +"/cloudsearch:v1/cloudsearch.settings.searchapplications.list": list_setting_searchapplications +"/cloudsearch:v1/cloudsearch.settings.searchapplications.list/debugOptions.enableDebugging": debug_options_enable_debugging +"/cloudsearch:v1/cloudsearch.settings.searchapplications.list/pageSize": page_size +"/cloudsearch:v1/cloudsearch.settings.searchapplications.list/pageToken": page_token +"/cloudsearch:v1/cloudsearch.settings.searchapplications.reset": reset_searchapplication_search_application +"/cloudsearch:v1/cloudsearch.settings.searchapplications.reset/name": name +"/cloudsearch:v1/cloudsearch.settings.searchapplications.update": update_setting_searchapplication +"/cloudsearch:v1/cloudsearch.settings.searchapplications.update/name": name +"/cloudsearch:v1/cloudsearch.stats.getIndex": get_stat_index +"/cloudsearch:v1/cloudsearch.stats.getIndex/fromDate.day": from_date_day +"/cloudsearch:v1/cloudsearch.stats.getIndex/fromDate.month": from_date_month +"/cloudsearch:v1/cloudsearch.stats.getIndex/fromDate.year": from_date_year +"/cloudsearch:v1/cloudsearch.stats.getIndex/toDate.day": to_date_day +"/cloudsearch:v1/cloudsearch.stats.getIndex/toDate.month": to_date_month +"/cloudsearch:v1/cloudsearch.stats.getIndex/toDate.year": to_date_year +"/cloudsearch:v1/cloudsearch.stats.index.datasources.get": get_stat_index_datasource +"/cloudsearch:v1/cloudsearch.stats.index.datasources.get/fromDate.day": from_date_day +"/cloudsearch:v1/cloudsearch.stats.index.datasources.get/fromDate.month": from_date_month +"/cloudsearch:v1/cloudsearch.stats.index.datasources.get/fromDate.year": from_date_year +"/cloudsearch:v1/cloudsearch.stats.index.datasources.get/name": name +"/cloudsearch:v1/cloudsearch.stats.index.datasources.get/toDate.day": to_date_day +"/cloudsearch:v1/cloudsearch.stats.index.datasources.get/toDate.month": to_date_month +"/cloudsearch:v1/cloudsearch.stats.index.datasources.get/toDate.year": to_date_year +"/cloudsearch:v1/fields": fields +"/cloudsearch:v1/key": key +"/cloudsearch:v1/quotaUser": quota_user "/cloudshell:v1/CancelOperationRequest": cancel_operation_request "/cloudshell:v1/Empty": empty "/cloudshell:v1/Environment": environment @@ -36638,6 +37387,15 @@ "/content:v2/CarriersCarrier/name": name "/content:v2/CarriersCarrier/services": services "/content:v2/CarriersCarrier/services/service": service +"/content:v2/CustomAttribute": custom_attribute +"/content:v2/CustomAttribute/name": name +"/content:v2/CustomAttribute/type": type +"/content:v2/CustomAttribute/unit": unit +"/content:v2/CustomAttribute/value": value +"/content:v2/CustomGroup": custom_group +"/content:v2/CustomGroup/attributes": attributes +"/content:v2/CustomGroup/attributes/attribute": attribute +"/content:v2/CustomGroup/name": name "/content:v2/CustomerReturnReason": customer_return_reason "/content:v2/CustomerReturnReason/description": description "/content:v2/CustomerReturnReason/reasonCode": reason_code @@ -36812,6 +37570,7 @@ "/content:v2/Inventory/customLabel3": custom_label3 "/content:v2/Inventory/customLabel4": custom_label4 "/content:v2/Inventory/installment": installment +"/content:v2/Inventory/instoreProductLocation": instore_product_location "/content:v2/Inventory/kind": kind "/content:v2/Inventory/loyaltyPoints": loyalty_points "/content:v2/Inventory/pickup": pickup @@ -36848,6 +37607,7 @@ "/content:v2/InventorySetRequest/customLabel3": custom_label3 "/content:v2/InventorySetRequest/customLabel4": custom_label4 "/content:v2/InventorySetRequest/installment": installment +"/content:v2/InventorySetRequest/instoreProductLocation": instore_product_location "/content:v2/InventorySetRequest/loyaltyPoints": loyalty_points "/content:v2/InventorySetRequest/pickup": pickup "/content:v2/InventorySetRequest/price": price @@ -37067,6 +37827,8 @@ "/content:v2/OrderLineItemProduct/channel": channel "/content:v2/OrderLineItemProduct/condition": condition "/content:v2/OrderLineItemProduct/contentLanguage": content_language +"/content:v2/OrderLineItemProduct/fees": fees +"/content:v2/OrderLineItemProduct/fees/fee": fee "/content:v2/OrderLineItemProduct/gtin": gtin "/content:v2/OrderLineItemProduct/id": id "/content:v2/OrderLineItemProduct/imageLink": image_link @@ -37079,6 +37841,10 @@ "/content:v2/OrderLineItemProduct/title": title "/content:v2/OrderLineItemProduct/variantAttributes": variant_attributes "/content:v2/OrderLineItemProduct/variantAttributes/variant_attribute": variant_attribute +"/content:v2/OrderLineItemProductFee": order_line_item_product_fee +"/content:v2/OrderLineItemProductFee/amount": amount +"/content:v2/OrderLineItemProductFee/id": id +"/content:v2/OrderLineItemProductFee/name": name "/content:v2/OrderLineItemProductVariantAttribute": order_line_item_product_variant_attribute "/content:v2/OrderLineItemProductVariantAttribute/dimension": dimension "/content:v2/OrderLineItemProductVariantAttribute/value": value @@ -39514,6 +40280,7 @@ "/dataflow:v1b3/Job/requestedState": requested_state "/dataflow:v1b3/Job/stageStates": stage_states "/dataflow:v1b3/Job/stageStates/stage_state": stage_state +"/dataflow:v1b3/Job/startTime": start_time "/dataflow:v1b3/Job/steps": steps "/dataflow:v1b3/Job/steps/step": step "/dataflow:v1b3/Job/tempFiles": temp_files @@ -39850,6 +40617,9 @@ "/dataflow:v1b3/StreamLocation/pubsubLocation": pubsub_location "/dataflow:v1b3/StreamLocation/sideInputLocation": side_input_location "/dataflow:v1b3/StreamLocation/streamingStageLocation": streaming_stage_location +"/dataflow:v1b3/StreamingApplianceSnapshotConfig": streaming_appliance_snapshot_config +"/dataflow:v1b3/StreamingApplianceSnapshotConfig/importStateEndpoint": import_state_endpoint +"/dataflow:v1b3/StreamingApplianceSnapshotConfig/snapshotId": snapshot_id "/dataflow:v1b3/StreamingComputationConfig": streaming_computation_config "/dataflow:v1b3/StreamingComputationConfig/computationId": computation_id "/dataflow:v1b3/StreamingComputationConfig/instructions": instructions @@ -39876,6 +40646,7 @@ "/dataflow:v1b3/StreamingSetupTask": streaming_setup_task "/dataflow:v1b3/StreamingSetupTask/drain": drain "/dataflow:v1b3/StreamingSetupTask/receiveWorkPort": receive_work_port +"/dataflow:v1b3/StreamingSetupTask/snapshotConfig": snapshot_config "/dataflow:v1b3/StreamingSetupTask/streamingComputationTopology": streaming_computation_topology "/dataflow:v1b3/StreamingSetupTask/workerHarnessPort": worker_harness_port "/dataflow:v1b3/StreamingSideInputLocation": streaming_side_input_location @@ -58505,6 +59276,8 @@ "/dlp:v2/GooglePrivacyDlpV2BigQueryKey/rowNumber": row_number "/dlp:v2/GooglePrivacyDlpV2BigQueryKey/tableReference": table_reference "/dlp:v2/GooglePrivacyDlpV2BigQueryOptions": google_privacy_dlp_v2_big_query_options +"/dlp:v2/GooglePrivacyDlpV2BigQueryOptions/excludedFields": excluded_fields +"/dlp:v2/GooglePrivacyDlpV2BigQueryOptions/excludedFields/excluded_field": excluded_field "/dlp:v2/GooglePrivacyDlpV2BigQueryOptions/identifyingFields": identifying_fields "/dlp:v2/GooglePrivacyDlpV2BigQueryOptions/identifyingFields/identifying_field": identifying_field "/dlp:v2/GooglePrivacyDlpV2BigQueryOptions/rowsLimit": rows_limit @@ -63605,6 +64378,84 @@ "/firebaserules:v1/key": key "/firebaserules:v1/quotaUser": quota_user "/firestore:v1/Empty": empty +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsMetadata": google_firestore_admin_v1_export_documents_metadata +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsMetadata/collectionIds": collection_ids +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsMetadata/collectionIds/collection_id": collection_id +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsMetadata/endTime": end_time +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsMetadata/operationState": operation_state +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsMetadata/outputUriPrefix": output_uri_prefix +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsMetadata/progressBytes": progress_bytes +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsMetadata/progressDocuments": progress_documents +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsMetadata/startTime": start_time +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsRequest": google_firestore_admin_v1_export_documents_request +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsRequest/collectionIds": collection_ids +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsRequest/collectionIds/collection_id": collection_id +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsRequest/outputUriPrefix": output_uri_prefix +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsResponse": google_firestore_admin_v1_export_documents_response +"/firestore:v1/GoogleFirestoreAdminV1ExportDocumentsResponse/outputUriPrefix": output_uri_prefix +"/firestore:v1/GoogleFirestoreAdminV1Field": google_firestore_admin_v1_field +"/firestore:v1/GoogleFirestoreAdminV1Field/indexConfig": index_config +"/firestore:v1/GoogleFirestoreAdminV1Field/name": name +"/firestore:v1/GoogleFirestoreAdminV1FieldOperationMetadata": google_firestore_admin_v1_field_operation_metadata +"/firestore:v1/GoogleFirestoreAdminV1FieldOperationMetadata/endTime": end_time +"/firestore:v1/GoogleFirestoreAdminV1FieldOperationMetadata/field": field +"/firestore:v1/GoogleFirestoreAdminV1FieldOperationMetadata/indexConfigDeltas": index_config_deltas +"/firestore:v1/GoogleFirestoreAdminV1FieldOperationMetadata/indexConfigDeltas/index_config_delta": index_config_delta +"/firestore:v1/GoogleFirestoreAdminV1FieldOperationMetadata/progressBytes": progress_bytes +"/firestore:v1/GoogleFirestoreAdminV1FieldOperationMetadata/progressDocuments": progress_documents +"/firestore:v1/GoogleFirestoreAdminV1FieldOperationMetadata/startTime": start_time +"/firestore:v1/GoogleFirestoreAdminV1FieldOperationMetadata/state": state +"/firestore:v1/GoogleFirestoreAdminV1ImportDocumentsMetadata": google_firestore_admin_v1_import_documents_metadata +"/firestore:v1/GoogleFirestoreAdminV1ImportDocumentsMetadata/collectionIds": collection_ids +"/firestore:v1/GoogleFirestoreAdminV1ImportDocumentsMetadata/collectionIds/collection_id": collection_id +"/firestore:v1/GoogleFirestoreAdminV1ImportDocumentsMetadata/endTime": end_time +"/firestore:v1/GoogleFirestoreAdminV1ImportDocumentsMetadata/inputUriPrefix": input_uri_prefix +"/firestore:v1/GoogleFirestoreAdminV1ImportDocumentsMetadata/operationState": operation_state +"/firestore:v1/GoogleFirestoreAdminV1ImportDocumentsMetadata/progressBytes": progress_bytes +"/firestore:v1/GoogleFirestoreAdminV1ImportDocumentsMetadata/progressDocuments": progress_documents +"/firestore:v1/GoogleFirestoreAdminV1ImportDocumentsMetadata/startTime": start_time +"/firestore:v1/GoogleFirestoreAdminV1ImportDocumentsRequest": google_firestore_admin_v1_import_documents_request +"/firestore:v1/GoogleFirestoreAdminV1ImportDocumentsRequest/collectionIds": collection_ids +"/firestore:v1/GoogleFirestoreAdminV1ImportDocumentsRequest/collectionIds/collection_id": collection_id +"/firestore:v1/GoogleFirestoreAdminV1ImportDocumentsRequest/inputUriPrefix": input_uri_prefix +"/firestore:v1/GoogleFirestoreAdminV1Index": google_firestore_admin_v1_index +"/firestore:v1/GoogleFirestoreAdminV1Index/fields": fields +"/firestore:v1/GoogleFirestoreAdminV1Index/fields/field": field +"/firestore:v1/GoogleFirestoreAdminV1Index/name": name +"/firestore:v1/GoogleFirestoreAdminV1Index/queryScope": query_scope +"/firestore:v1/GoogleFirestoreAdminV1Index/state": state +"/firestore:v1/GoogleFirestoreAdminV1IndexConfig": google_firestore_admin_v1_index_config +"/firestore:v1/GoogleFirestoreAdminV1IndexConfig/ancestorField": ancestor_field +"/firestore:v1/GoogleFirestoreAdminV1IndexConfig/indexes": indexes +"/firestore:v1/GoogleFirestoreAdminV1IndexConfig/indexes/index": index +"/firestore:v1/GoogleFirestoreAdminV1IndexConfig/reverting": reverting +"/firestore:v1/GoogleFirestoreAdminV1IndexConfig/usesAncestorConfig": uses_ancestor_config +"/firestore:v1/GoogleFirestoreAdminV1IndexConfigDelta": google_firestore_admin_v1_index_config_delta +"/firestore:v1/GoogleFirestoreAdminV1IndexConfigDelta/changeType": change_type +"/firestore:v1/GoogleFirestoreAdminV1IndexConfigDelta/index": index +"/firestore:v1/GoogleFirestoreAdminV1IndexField": google_firestore_admin_v1_index_field +"/firestore:v1/GoogleFirestoreAdminV1IndexField/arrayConfig": array_config +"/firestore:v1/GoogleFirestoreAdminV1IndexField/fieldPath": field_path +"/firestore:v1/GoogleFirestoreAdminV1IndexField/order": order +"/firestore:v1/GoogleFirestoreAdminV1IndexOperationMetadata": google_firestore_admin_v1_index_operation_metadata +"/firestore:v1/GoogleFirestoreAdminV1IndexOperationMetadata/endTime": end_time +"/firestore:v1/GoogleFirestoreAdminV1IndexOperationMetadata/index": index +"/firestore:v1/GoogleFirestoreAdminV1IndexOperationMetadata/progressBytes": progress_bytes +"/firestore:v1/GoogleFirestoreAdminV1IndexOperationMetadata/progressDocuments": progress_documents +"/firestore:v1/GoogleFirestoreAdminV1IndexOperationMetadata/startTime": start_time +"/firestore:v1/GoogleFirestoreAdminV1IndexOperationMetadata/state": state +"/firestore:v1/GoogleFirestoreAdminV1ListFieldsResponse": google_firestore_admin_v1_list_fields_response +"/firestore:v1/GoogleFirestoreAdminV1ListFieldsResponse/fields": fields +"/firestore:v1/GoogleFirestoreAdminV1ListFieldsResponse/fields/field": field +"/firestore:v1/GoogleFirestoreAdminV1ListFieldsResponse/nextPageToken": next_page_token +"/firestore:v1/GoogleFirestoreAdminV1ListIndexesResponse": google_firestore_admin_v1_list_indexes_response +"/firestore:v1/GoogleFirestoreAdminV1ListIndexesResponse/indexes": indexes +"/firestore:v1/GoogleFirestoreAdminV1ListIndexesResponse/indexes/index": index +"/firestore:v1/GoogleFirestoreAdminV1ListIndexesResponse/nextPageToken": next_page_token +"/firestore:v1/GoogleFirestoreAdminV1LocationMetadata": google_firestore_admin_v1_location_metadata +"/firestore:v1/GoogleFirestoreAdminV1Progress": google_firestore_admin_v1_progress +"/firestore:v1/GoogleFirestoreAdminV1Progress/completedWork": completed_work +"/firestore:v1/GoogleFirestoreAdminV1Progress/estimatedWork": estimated_work "/firestore:v1/GoogleLongrunningCancelOperationRequest": google_longrunning_cancel_operation_request "/firestore:v1/GoogleLongrunningListOperationsResponse": google_longrunning_list_operations_response "/firestore:v1/GoogleLongrunningListOperationsResponse/nextPageToken": next_page_token @@ -63637,6 +64488,31 @@ "/firestore:v1/Status/details/detail/detail": detail "/firestore:v1/Status/message": message "/firestore:v1/fields": fields +"/firestore:v1/firestore.projects.databases.collectionGroups.fields.get": get_project_database_collection_group_field +"/firestore:v1/firestore.projects.databases.collectionGroups.fields.get/name": name +"/firestore:v1/firestore.projects.databases.collectionGroups.fields.list": list_project_database_collection_group_fields +"/firestore:v1/firestore.projects.databases.collectionGroups.fields.list/filter": filter +"/firestore:v1/firestore.projects.databases.collectionGroups.fields.list/pageSize": page_size +"/firestore:v1/firestore.projects.databases.collectionGroups.fields.list/pageToken": page_token +"/firestore:v1/firestore.projects.databases.collectionGroups.fields.list/parent": parent +"/firestore:v1/firestore.projects.databases.collectionGroups.fields.patch": patch_project_database_collection_group_field +"/firestore:v1/firestore.projects.databases.collectionGroups.fields.patch/name": name +"/firestore:v1/firestore.projects.databases.collectionGroups.fields.patch/updateMask": update_mask +"/firestore:v1/firestore.projects.databases.collectionGroups.indexes.create": create_project_database_collection_group_index +"/firestore:v1/firestore.projects.databases.collectionGroups.indexes.create/parent": parent +"/firestore:v1/firestore.projects.databases.collectionGroups.indexes.delete": delete_project_database_collection_group_index +"/firestore:v1/firestore.projects.databases.collectionGroups.indexes.delete/name": name +"/firestore:v1/firestore.projects.databases.collectionGroups.indexes.get": get_project_database_collection_group_index +"/firestore:v1/firestore.projects.databases.collectionGroups.indexes.get/name": name +"/firestore:v1/firestore.projects.databases.collectionGroups.indexes.list": list_project_database_collection_group_indexes +"/firestore:v1/firestore.projects.databases.collectionGroups.indexes.list/filter": filter +"/firestore:v1/firestore.projects.databases.collectionGroups.indexes.list/pageSize": page_size +"/firestore:v1/firestore.projects.databases.collectionGroups.indexes.list/pageToken": page_token +"/firestore:v1/firestore.projects.databases.collectionGroups.indexes.list/parent": parent +"/firestore:v1/firestore.projects.databases.exportDocuments": export_project_database_documents +"/firestore:v1/firestore.projects.databases.exportDocuments/name": name +"/firestore:v1/firestore.projects.databases.importDocuments": import_project_database_documents +"/firestore:v1/firestore.projects.databases.importDocuments/name": name "/firestore:v1/firestore.projects.databases.operations.cancel": cancel_project_database_operation "/firestore:v1/firestore.projects.databases.operations.cancel/name": name "/firestore:v1/firestore.projects.databases.operations.delete": delete_project_database_operation @@ -69375,6 +70251,7 @@ "/jobs:v3p1beta1/jobs.projects.complete": complete_project "/jobs:v3p1beta1/jobs.projects.complete/companyName": company_name "/jobs:v3p1beta1/jobs.projects.complete/languageCode": language_code +"/jobs:v3p1beta1/jobs.projects.complete/languageCodes": language_codes "/jobs:v3p1beta1/jobs.projects.complete/name": name "/jobs:v3p1beta1/jobs.projects.complete/pageSize": page_size "/jobs:v3p1beta1/jobs.projects.complete/query": query @@ -71651,6 +72528,7 @@ "/monitoring:v3/InternalChecker/gcpZone": gcp_zone "/monitoring:v3/InternalChecker/name": name "/monitoring:v3/InternalChecker/network": network +"/monitoring:v3/InternalChecker/peerProjectId": peer_project_id "/monitoring:v3/InternalChecker/projectId": project_id "/monitoring:v3/LabelDescriptor": label_descriptor "/monitoring:v3/LabelDescriptor/description": description @@ -71859,6 +72737,24 @@ "/monitoring:v3/VerifyNotificationChannelRequest/code": code "/monitoring:v3/fields": fields "/monitoring:v3/key": key +"/monitoring:v3/monitoring.metricDescriptors.create": create_metric_descriptor +"/monitoring:v3/monitoring.metricDescriptors.create/name": name +"/monitoring:v3/monitoring.metricDescriptors.delete": delete_metric_descriptor +"/monitoring:v3/monitoring.metricDescriptors.delete/name": name +"/monitoring:v3/monitoring.metricDescriptors.get": get_metric_descriptor +"/monitoring:v3/monitoring.metricDescriptors.get/name": name +"/monitoring:v3/monitoring.metricDescriptors.list": list_metric_descriptors +"/monitoring:v3/monitoring.metricDescriptors.list/filter": filter +"/monitoring:v3/monitoring.metricDescriptors.list/name": name +"/monitoring:v3/monitoring.metricDescriptors.list/pageSize": page_size +"/monitoring:v3/monitoring.metricDescriptors.list/pageToken": page_token +"/monitoring:v3/monitoring.monitoredResourceDescriptors.get": get_monitored_resource_descriptor +"/monitoring:v3/monitoring.monitoredResourceDescriptors.get/name": name +"/monitoring:v3/monitoring.monitoredResourceDescriptors.list": list_monitored_resource_descriptors +"/monitoring:v3/monitoring.monitoredResourceDescriptors.list/filter": filter +"/monitoring:v3/monitoring.monitoredResourceDescriptors.list/name": name +"/monitoring:v3/monitoring.monitoredResourceDescriptors.list/pageSize": page_size +"/monitoring:v3/monitoring.monitoredResourceDescriptors.list/pageToken": page_token "/monitoring:v3/monitoring.projects.alertPolicies.create": create_project_alert_policy "/monitoring:v3/monitoring.projects.alertPolicies.create/name": name "/monitoring:v3/monitoring.projects.alertPolicies.delete": delete_project_alert_policy @@ -71976,6 +72872,21 @@ "/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.timeSeries.create": create_time_series +"/monitoring:v3/monitoring.timeSeries.create/name": name +"/monitoring:v3/monitoring.timeSeries.list": list_time_series +"/monitoring:v3/monitoring.timeSeries.list/aggregation.alignmentPeriod": aggregation_alignment_period +"/monitoring:v3/monitoring.timeSeries.list/aggregation.crossSeriesReducer": aggregation_cross_series_reducer +"/monitoring:v3/monitoring.timeSeries.list/aggregation.groupByFields": aggregation_group_by_fields +"/monitoring:v3/monitoring.timeSeries.list/aggregation.perSeriesAligner": aggregation_per_series_aligner +"/monitoring:v3/monitoring.timeSeries.list/filter": filter +"/monitoring:v3/monitoring.timeSeries.list/interval.endTime": interval_end_time +"/monitoring:v3/monitoring.timeSeries.list/interval.startTime": interval_start_time +"/monitoring:v3/monitoring.timeSeries.list/name": name +"/monitoring:v3/monitoring.timeSeries.list/orderBy": order_by +"/monitoring:v3/monitoring.timeSeries.list/pageSize": page_size +"/monitoring:v3/monitoring.timeSeries.list/pageToken": page_token +"/monitoring:v3/monitoring.timeSeries.list/view": view "/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 @@ -72388,6 +73299,8 @@ "/oslogin:v1/key": key "/oslogin:v1/oslogin.users.getLoginProfile": get_user_login_profile "/oslogin:v1/oslogin.users.getLoginProfile/name": name +"/oslogin:v1/oslogin.users.getLoginProfile/projectId": project_id +"/oslogin:v1/oslogin.users.getLoginProfile/systemId": system_id "/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 @@ -72430,6 +73343,9 @@ "/oslogin:v1alpha/key": key "/oslogin:v1alpha/oslogin.users.getLoginProfile": get_user_login_profile "/oslogin:v1alpha/oslogin.users.getLoginProfile/name": name +"/oslogin:v1alpha/oslogin.users.getLoginProfile/operatingSystemType": operating_system_type +"/oslogin:v1alpha/oslogin.users.getLoginProfile/projectId": project_id +"/oslogin:v1alpha/oslogin.users.getLoginProfile/systemId": system_id "/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 @@ -72473,6 +73389,8 @@ "/oslogin:v1beta/key": key "/oslogin:v1beta/oslogin.users.getLoginProfile": get_user_login_profile "/oslogin:v1beta/oslogin.users.getLoginProfile/name": name +"/oslogin:v1beta/oslogin.users.getLoginProfile/projectId": project_id +"/oslogin:v1beta/oslogin.users.getLoginProfile/systemId": system_id "/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 @@ -75859,6 +76777,8 @@ "/redis:v1/ListInstancesResponse/instances": instances "/redis:v1/ListInstancesResponse/instances/instance": instance "/redis:v1/ListInstancesResponse/nextPageToken": next_page_token +"/redis:v1/ListInstancesResponse/unreachable": unreachable +"/redis:v1/ListInstancesResponse/unreachable/unreachable": unreachable "/redis:v1/ListLocationsResponse": list_locations_response "/redis:v1/ListLocationsResponse/locations": locations "/redis:v1/ListLocationsResponse/locations/location": location @@ -75962,6 +76882,8 @@ "/redis:v1beta1/ListInstancesResponse/instances": instances "/redis:v1beta1/ListInstancesResponse/instances/instance": instance "/redis:v1beta1/ListInstancesResponse/nextPageToken": next_page_token +"/redis:v1beta1/ListInstancesResponse/unreachable": unreachable +"/redis:v1beta1/ListInstancesResponse/unreachable/unreachable": unreachable "/redis:v1beta1/ListLocationsResponse": list_locations_response "/redis:v1beta1/ListLocationsResponse/locations": locations "/redis:v1beta1/ListLocationsResponse/locations/location": location @@ -77919,6 +78841,7 @@ "/serviceconsumermanagement:v1/BackendRule/address": address "/serviceconsumermanagement:v1/BackendRule/deadline": deadline "/serviceconsumermanagement:v1/BackendRule/minDeadline": min_deadline +"/serviceconsumermanagement:v1/BackendRule/operationDeadline": operation_deadline "/serviceconsumermanagement:v1/BackendRule/selector": selector "/serviceconsumermanagement:v1/Billing": billing "/serviceconsumermanagement:v1/Billing/consumerDestinations": consumer_destinations @@ -78390,7 +79313,9 @@ "/servicecontrol:v1/CheckResponse/quotaInfo": quota_info "/servicecontrol:v1/CheckResponse/serviceConfigId": service_config_id "/servicecontrol:v1/ConsumerInfo": consumer_info +"/servicecontrol:v1/ConsumerInfo/consumerNumber": consumer_number "/servicecontrol:v1/ConsumerInfo/projectNumber": project_number +"/servicecontrol:v1/ConsumerInfo/type": type "/servicecontrol:v1/Distribution": distribution "/servicecontrol:v1/Distribution/bucketCounts": bucket_counts "/servicecontrol:v1/Distribution/bucketCounts/bucket_count": bucket_count @@ -79564,6 +80489,7 @@ "/servicenetworking:v1beta/AddSubnetworkRequest/description": description "/servicenetworking:v1beta/AddSubnetworkRequest/ipPrefixLength": ip_prefix_length "/servicenetworking:v1beta/AddSubnetworkRequest/region": region +"/servicenetworking:v1beta/AddSubnetworkRequest/requestedAddress": requested_address "/servicenetworking:v1beta/AddSubnetworkRequest/subnetwork": subnetwork "/servicenetworking:v1beta/AddSubnetworkRequest/subnetworkUsers": subnetwork_users "/servicenetworking:v1beta/AddSubnetworkRequest/subnetworkUsers/subnetwork_user": subnetwork_user @@ -79610,6 +80536,7 @@ "/servicenetworking:v1beta/BackendRule/address": address "/servicenetworking:v1beta/BackendRule/deadline": deadline "/servicenetworking:v1beta/BackendRule/minDeadline": min_deadline +"/servicenetworking:v1beta/BackendRule/operationDeadline": operation_deadline "/servicenetworking:v1beta/BackendRule/selector": selector "/servicenetworking:v1beta/Billing": billing "/servicenetworking:v1beta/Billing/consumerDestinations": consumer_destinations @@ -79869,6 +80796,7 @@ "/servicenetworking:v1beta/Subnetwork": subnetwork "/servicenetworking:v1beta/Subnetwork/ipCidrRange": ip_cidr_range "/servicenetworking:v1beta/Subnetwork/name": name +"/servicenetworking:v1beta/Subnetwork/network": network "/servicenetworking:v1beta/SystemParameter": system_parameter "/servicenetworking:v1beta/SystemParameter/httpHeader": http_header "/servicenetworking:v1beta/SystemParameter/name": name @@ -79956,6 +80884,7 @@ "/serviceusage:v1/BackendRule/address": address "/serviceusage:v1/BackendRule/deadline": deadline "/serviceusage:v1/BackendRule/minDeadline": min_deadline +"/serviceusage:v1/BackendRule/operationDeadline": operation_deadline "/serviceusage:v1/BackendRule/selector": selector "/serviceusage:v1/BatchEnableServicesRequest": batch_enable_services_request "/serviceusage:v1/BatchEnableServicesRequest/serviceIds": service_ids @@ -80422,6 +81351,7 @@ "/serviceusage:v1beta1/BackendRule/address": address "/serviceusage:v1beta1/BackendRule/deadline": deadline "/serviceusage:v1beta1/BackendRule/minDeadline": min_deadline +"/serviceusage:v1beta1/BackendRule/operationDeadline": operation_deadline "/serviceusage:v1beta1/BackendRule/selector": selector "/serviceusage:v1beta1/BatchEnableServicesRequest": batch_enable_services_request "/serviceusage:v1beta1/BatchEnableServicesRequest/serviceIds": service_ids @@ -87142,6 +88072,7 @@ "/testing:v1/AndroidModel/form": form "/testing:v1/AndroidModel/formFactor": form_factor "/testing:v1/AndroidModel/id": id +"/testing:v1/AndroidModel/lowFpsVideoRecording": low_fps_video_recording "/testing:v1/AndroidModel/manufacturer": manufacturer "/testing:v1/AndroidModel/name": name "/testing:v1/AndroidModel/screenDensity": screen_density @@ -88894,6 +89825,30 @@ "/videointelligence:v1/GoogleCloudVideointelligenceV1_LabelSegment/segment": segment "/videointelligence:v1/GoogleCloudVideointelligenceV1_ShotChangeDetectionConfig": google_cloud_videointelligence_v1_shot_change_detection_config "/videointelligence:v1/GoogleCloudVideointelligenceV1_ShotChangeDetectionConfig/model": model +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechContext": google_cloud_videointelligence_v1_speech_context +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechContext/phrases": phrases +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechContext/phrases/phrase": phrase +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative": google_cloud_videointelligence_v1_speech_recognition_alternative +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative/confidence": confidence +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative/transcript": transcript +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative/words": words +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative/words/word": word +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscription": google_cloud_videointelligence_v1_speech_transcription +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscription/alternatives": alternatives +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscription/alternatives/alternative": alternative +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscription/languageCode": language_code +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig": google_cloud_videointelligence_v1_speech_transcription_config +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig/audioTracks": audio_tracks +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig/audioTracks/audio_track": audio_track +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig/diarizationSpeakerCount": diarization_speaker_count +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig/enableAutomaticPunctuation": enable_automatic_punctuation +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig/enableSpeakerDiarization": enable_speaker_diarization +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig/enableWordConfidence": enable_word_confidence +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig/filterProfanity": filter_profanity +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig/languageCode": language_code +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig/maxAlternatives": max_alternatives +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig/speechContexts": speech_contexts +"/videointelligence:v1/GoogleCloudVideointelligenceV1_SpeechTranscriptionConfig/speechContexts/speech_context": speech_context "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoAnnotationProgress": google_cloud_videointelligence_v1_video_annotation_progress "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoAnnotationProgress/inputUri": input_uri "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoAnnotationProgress/progressPercent": progress_percent @@ -88911,15 +89866,24 @@ "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/shotAnnotations/shot_annotation": shot_annotation "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/shotLabelAnnotations": shot_label_annotations "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/shotLabelAnnotations/shot_label_annotation": shot_label_annotation +"/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/speechTranscriptions": speech_transcriptions +"/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/speechTranscriptions/speech_transcription": speech_transcription "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoContext": google_cloud_videointelligence_v1_video_context "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoContext/explicitContentDetectionConfig": explicit_content_detection_config "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoContext/labelDetectionConfig": label_detection_config "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoContext/segments": segments "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoContext/segments/segment": segment "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoContext/shotChangeDetectionConfig": shot_change_detection_config +"/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoContext/speechTranscriptionConfig": speech_transcription_config "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoSegment": google_cloud_videointelligence_v1_video_segment "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoSegment/endTimeOffset": end_time_offset "/videointelligence:v1/GoogleCloudVideointelligenceV1_VideoSegment/startTimeOffset": start_time_offset +"/videointelligence:v1/GoogleCloudVideointelligenceV1_WordInfo": google_cloud_videointelligence_v1_word_info +"/videointelligence:v1/GoogleCloudVideointelligenceV1_WordInfo/confidence": confidence +"/videointelligence:v1/GoogleCloudVideointelligenceV1_WordInfo/endTime": end_time +"/videointelligence:v1/GoogleCloudVideointelligenceV1_WordInfo/speakerTag": speaker_tag +"/videointelligence:v1/GoogleCloudVideointelligenceV1_WordInfo/startTime": start_time +"/videointelligence:v1/GoogleCloudVideointelligenceV1_WordInfo/word": word "/videointelligence:v1/GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress": google_cloud_videointelligence_v1beta1_annotate_video_progress "/videointelligence:v1/GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress/annotationProgress": annotation_progress "/videointelligence:v1/GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress/annotationProgress/annotation_progress": annotation_progress @@ -88989,6 +89953,15 @@ "/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_LabelSegment": google_cloud_videointelligence_v1beta2_label_segment "/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_LabelSegment/confidence": confidence "/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_LabelSegment/segment": segment +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative": google_cloud_videointelligence_v1beta2_speech_recognition_alternative +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative/confidence": confidence +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative/transcript": transcript +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative/words": words +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative/words/word": word +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_SpeechTranscription": google_cloud_videointelligence_v1beta2_speech_transcription +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_SpeechTranscription/alternatives": alternatives +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_SpeechTranscription/alternatives/alternative": alternative +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_SpeechTranscription/languageCode": language_code "/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress": google_cloud_videointelligence_v1beta2_video_annotation_progress "/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress/inputUri": input_uri "/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress/progressPercent": progress_percent @@ -89007,9 +89980,17 @@ "/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults/shotAnnotations/shot_annotation": shot_annotation "/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults/shotLabelAnnotations": shot_label_annotations "/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults/shotLabelAnnotations/shot_label_annotation": shot_label_annotation +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults/speechTranscriptions": speech_transcriptions +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults/speechTranscriptions/speech_transcription": speech_transcription "/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_VideoSegment": google_cloud_videointelligence_v1beta2_video_segment "/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_VideoSegment/endTimeOffset": end_time_offset "/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_VideoSegment/startTimeOffset": start_time_offset +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_WordInfo": google_cloud_videointelligence_v1beta2_word_info +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_WordInfo/confidence": confidence +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_WordInfo/endTime": end_time +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_WordInfo/speakerTag": speaker_tag +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_WordInfo/startTime": start_time +"/videointelligence:v1/GoogleCloudVideointelligenceV1beta2_WordInfo/word": word "/videointelligence:v1/GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress": google_cloud_videointelligence_v1p1beta1_annotate_video_progress "/videointelligence:v1/GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress/annotationProgress": annotation_progress "/videointelligence:v1/GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress/annotationProgress/annotation_progress": annotation_progress @@ -89154,6 +90135,15 @@ "/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame": google_cloud_videointelligence_v1p2beta1_object_tracking_frame "/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame/normalizedBoundingBox": normalized_bounding_box "/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame/timeOffset": time_offset +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative": google_cloud_videointelligence_v1p2beta1_speech_recognition_alternative +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative/confidence": confidence +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative/transcript": transcript +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative/words": words +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative/words/word": word +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription": google_cloud_videointelligence_v1p2beta1_speech_transcription +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription/alternatives": alternatives +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription/alternatives/alternative": alternative +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription/languageCode": language_code "/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_TextAnnotation": google_cloud_videointelligence_v1p2beta1_text_annotation "/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_TextAnnotation/confidence": confidence "/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_TextAnnotation/frames": frames @@ -89189,11 +90179,19 @@ "/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/shotAnnotations/shot_annotation": shot_annotation "/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/shotLabelAnnotations": shot_label_annotations "/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/shotLabelAnnotations/shot_label_annotation": shot_label_annotation +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/speechTranscriptions": speech_transcriptions +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/speechTranscriptions/speech_transcription": speech_transcription "/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/textAnnotations": text_annotations "/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/textAnnotations/text_annotation": text_annotation "/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_VideoSegment": google_cloud_videointelligence_v1p2beta1_video_segment "/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_VideoSegment/endTimeOffset": end_time_offset "/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_VideoSegment/startTimeOffset": start_time_offset +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_WordInfo": google_cloud_videointelligence_v1p2beta1_word_info +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_WordInfo/confidence": confidence +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_WordInfo/endTime": end_time +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_WordInfo/speakerTag": speaker_tag +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_WordInfo/startTime": start_time +"/videointelligence:v1/GoogleCloudVideointelligenceV1p2beta1_WordInfo/word": word "/videointelligence:v1/GoogleLongrunning_CancelOperationRequest": google_longrunning_cancel_operation_request "/videointelligence:v1/GoogleLongrunning_ListOperationsResponse": google_longrunning_list_operations_response "/videointelligence:v1/GoogleLongrunning_ListOperationsResponse/nextPageToken": next_page_token @@ -89547,6 +90545,15 @@ "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_LabelSegment": google_cloud_videointelligence_v1_label_segment "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_LabelSegment/confidence": confidence "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_LabelSegment/segment": segment +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative": google_cloud_videointelligence_v1_speech_recognition_alternative +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative/confidence": confidence +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative/transcript": transcript +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative/words": words +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative/words/word": word +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_SpeechTranscription": google_cloud_videointelligence_v1_speech_transcription +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_SpeechTranscription/alternatives": alternatives +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_SpeechTranscription/alternatives/alternative": alternative +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_SpeechTranscription/languageCode": language_code "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_VideoAnnotationProgress": google_cloud_videointelligence_v1_video_annotation_progress "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_VideoAnnotationProgress/inputUri": input_uri "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_VideoAnnotationProgress/progressPercent": progress_percent @@ -89565,9 +90572,17 @@ "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_VideoAnnotationResults/shotAnnotations/shot_annotation": shot_annotation "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_VideoAnnotationResults/shotLabelAnnotations": shot_label_annotations "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_VideoAnnotationResults/shotLabelAnnotations/shot_label_annotation": shot_label_annotation +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_VideoAnnotationResults/speechTranscriptions": speech_transcriptions +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_VideoAnnotationResults/speechTranscriptions/speech_transcription": speech_transcription "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_VideoSegment": google_cloud_videointelligence_v1_video_segment "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_VideoSegment/endTimeOffset": end_time_offset "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_VideoSegment/startTimeOffset": start_time_offset +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_WordInfo": google_cloud_videointelligence_v1_word_info +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_WordInfo/confidence": confidence +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_WordInfo/endTime": end_time +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_WordInfo/speakerTag": speaker_tag +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_WordInfo/startTime": start_time +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1_WordInfo/word": word "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress": google_cloud_videointelligence_v1beta1_annotate_video_progress "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress/annotationProgress": annotation_progress "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress/annotationProgress/annotation_progress": annotation_progress @@ -89654,6 +90669,30 @@ "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_LabelSegment/segment": segment "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_ShotChangeDetectionConfig": google_cloud_videointelligence_v1beta2_shot_change_detection_config "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_ShotChangeDetectionConfig/model": model +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechContext": google_cloud_videointelligence_v1beta2_speech_context +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechContext/phrases": phrases +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechContext/phrases/phrase": phrase +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative": google_cloud_videointelligence_v1beta2_speech_recognition_alternative +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative/confidence": confidence +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative/transcript": transcript +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative/words": words +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative/words/word": word +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscription": google_cloud_videointelligence_v1beta2_speech_transcription +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscription/alternatives": alternatives +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscription/alternatives/alternative": alternative +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscription/languageCode": language_code +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig": google_cloud_videointelligence_v1beta2_speech_transcription_config +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig/audioTracks": audio_tracks +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig/audioTracks/audio_track": audio_track +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig/diarizationSpeakerCount": diarization_speaker_count +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig/enableAutomaticPunctuation": enable_automatic_punctuation +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig/enableSpeakerDiarization": enable_speaker_diarization +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig/enableWordConfidence": enable_word_confidence +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig/filterProfanity": filter_profanity +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig/languageCode": language_code +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig/maxAlternatives": max_alternatives +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig/speechContexts": speech_contexts +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_SpeechTranscriptionConfig/speechContexts/speech_context": speech_context "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress": google_cloud_videointelligence_v1beta2_video_annotation_progress "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress/inputUri": input_uri "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress/progressPercent": progress_percent @@ -89673,15 +90712,24 @@ "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults/shotAnnotations/shot_annotation": shot_annotation "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults/shotLabelAnnotations": shot_label_annotations "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults/shotLabelAnnotations/shot_label_annotation": shot_label_annotation +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults/speechTranscriptions": speech_transcriptions +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults/speechTranscriptions/speech_transcription": speech_transcription "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoContext": google_cloud_videointelligence_v1beta2_video_context "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoContext/explicitContentDetectionConfig": explicit_content_detection_config "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoContext/labelDetectionConfig": label_detection_config "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoContext/segments": segments "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoContext/segments/segment": segment "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoContext/shotChangeDetectionConfig": shot_change_detection_config +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoContext/speechTranscriptionConfig": speech_transcription_config "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoSegment": google_cloud_videointelligence_v1beta2_video_segment "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoSegment/endTimeOffset": end_time_offset "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_VideoSegment/startTimeOffset": start_time_offset +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_WordInfo": google_cloud_videointelligence_v1beta2_word_info +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_WordInfo/confidence": confidence +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_WordInfo/endTime": end_time +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_WordInfo/speakerTag": speaker_tag +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_WordInfo/startTime": start_time +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1beta2_WordInfo/word": word "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress": google_cloud_videointelligence_v1p1beta1_annotate_video_progress "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress/annotationProgress": annotation_progress "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress/annotationProgress/annotation_progress": annotation_progress @@ -89829,6 +90877,15 @@ "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame": google_cloud_videointelligence_v1p2beta1_object_tracking_frame "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame/normalizedBoundingBox": normalized_bounding_box "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame/timeOffset": time_offset +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative": google_cloud_videointelligence_v1p2beta1_speech_recognition_alternative +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative/confidence": confidence +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative/transcript": transcript +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative/words": words +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative/words/word": word +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription": google_cloud_videointelligence_v1p2beta1_speech_transcription +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription/alternatives": alternatives +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription/alternatives/alternative": alternative +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription/languageCode": language_code "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_TextAnnotation": google_cloud_videointelligence_v1p2beta1_text_annotation "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_TextAnnotation/confidence": confidence "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_TextAnnotation/frames": frames @@ -89866,11 +90923,20 @@ "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/shotLabelAnnotations": shot_label_annotations ? "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/shotLabelAnnotations/shot_label_annotation" : shot_label_annotation +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/speechTranscriptions": speech_transcriptions +? "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/speechTranscriptions/speech_transcription" +: speech_transcription "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/textAnnotations": text_annotations "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/textAnnotations/text_annotation": text_annotation "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_VideoSegment": google_cloud_videointelligence_v1p2beta1_video_segment "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_VideoSegment/endTimeOffset": end_time_offset "/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_VideoSegment/startTimeOffset": start_time_offset +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_WordInfo": google_cloud_videointelligence_v1p2beta1_word_info +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_WordInfo/confidence": confidence +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_WordInfo/endTime": end_time +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_WordInfo/speakerTag": speaker_tag +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_WordInfo/startTime": start_time +"/videointelligence:v1beta2/GoogleCloudVideointelligenceV1p2beta1_WordInfo/word": word "/videointelligence:v1beta2/GoogleLongrunning_Operation": google_longrunning_operation "/videointelligence:v1beta2/GoogleLongrunning_Operation/done": done "/videointelligence:v1beta2/GoogleLongrunning_Operation/error": error @@ -89919,6 +90985,15 @@ "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_LabelSegment": google_cloud_videointelligence_v1_label_segment "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_LabelSegment/confidence": confidence "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_LabelSegment/segment": segment +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative": google_cloud_videointelligence_v1_speech_recognition_alternative +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative/confidence": confidence +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative/transcript": transcript +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative/words": words +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative/words/word": word +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_SpeechTranscription": google_cloud_videointelligence_v1_speech_transcription +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_SpeechTranscription/alternatives": alternatives +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_SpeechTranscription/alternatives/alternative": alternative +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_SpeechTranscription/languageCode": language_code "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationProgress": google_cloud_videointelligence_v1_video_annotation_progress "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationProgress/inputUri": input_uri "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationProgress/progressPercent": progress_percent @@ -89937,9 +91012,17 @@ "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/shotAnnotations/shot_annotation": shot_annotation "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/shotLabelAnnotations": shot_label_annotations "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/shotLabelAnnotations/shot_label_annotation": shot_label_annotation +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/speechTranscriptions": speech_transcriptions +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_VideoAnnotationResults/speechTranscriptions/speech_transcription": speech_transcription "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_VideoSegment": google_cloud_videointelligence_v1_video_segment "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_VideoSegment/endTimeOffset": end_time_offset "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_VideoSegment/startTimeOffset": start_time_offset +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_WordInfo": google_cloud_videointelligence_v1_word_info +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_WordInfo/confidence": confidence +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_WordInfo/endTime": end_time +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_WordInfo/speakerTag": speaker_tag +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_WordInfo/startTime": start_time +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1_WordInfo/word": word "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress": google_cloud_videointelligence_v1beta2_annotate_video_progress "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress/annotationProgress": annotation_progress "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress/annotationProgress/annotation_progress": annotation_progress @@ -89970,6 +91053,15 @@ "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_LabelSegment": google_cloud_videointelligence_v1beta2_label_segment "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_LabelSegment/confidence": confidence "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_LabelSegment/segment": segment +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative": google_cloud_videointelligence_v1beta2_speech_recognition_alternative +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative/confidence": confidence +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative/transcript": transcript +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative/words": words +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative/words/word": word +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_SpeechTranscription": google_cloud_videointelligence_v1beta2_speech_transcription +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_SpeechTranscription/alternatives": alternatives +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_SpeechTranscription/alternatives/alternative": alternative +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_SpeechTranscription/languageCode": language_code "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress": google_cloud_videointelligence_v1beta2_video_annotation_progress "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress/inputUri": input_uri "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress/progressPercent": progress_percent @@ -89990,9 +91082,18 @@ "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults/shotLabelAnnotations": shot_label_annotations ? "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults/shotLabelAnnotations/shot_label_annotation" : shot_label_annotation +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults/speechTranscriptions": speech_transcriptions +? "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults/speechTranscriptions/speech_transcription" +: speech_transcription "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_VideoSegment": google_cloud_videointelligence_v1beta2_video_segment "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_VideoSegment/endTimeOffset": end_time_offset "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_VideoSegment/startTimeOffset": start_time_offset +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_WordInfo": google_cloud_videointelligence_v1beta2_word_info +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_WordInfo/confidence": confidence +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_WordInfo/endTime": end_time +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_WordInfo/speakerTag": speaker_tag +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_WordInfo/startTime": start_time +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1beta2_WordInfo/word": word "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress": google_cloud_videointelligence_v1p1beta1_annotate_video_progress "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress/annotationProgress": annotation_progress "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress/annotationProgress/annotation_progress": annotation_progress @@ -90155,6 +91256,15 @@ "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame": google_cloud_videointelligence_v1p2beta1_object_tracking_frame "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame/normalizedBoundingBox": normalized_bounding_box "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame/timeOffset": time_offset +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative": google_cloud_videointelligence_v1p2beta1_speech_recognition_alternative +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative/confidence": confidence +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative/transcript": transcript +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative/words": words +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative/words/word": word +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription": google_cloud_videointelligence_v1p2beta1_speech_transcription +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription/alternatives": alternatives +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription/alternatives/alternative": alternative +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription/languageCode": language_code "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_TextAnnotation": google_cloud_videointelligence_v1p2beta1_text_annotation "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_TextAnnotation/confidence": confidence "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_TextAnnotation/frames": frames @@ -90192,11 +91302,20 @@ "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/shotLabelAnnotations": shot_label_annotations ? "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/shotLabelAnnotations/shot_label_annotation" : shot_label_annotation +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/speechTranscriptions": speech_transcriptions +? "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/speechTranscriptions/speech_transcription" +: speech_transcription "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/textAnnotations": text_annotations "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults/textAnnotations/text_annotation": text_annotation "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_VideoSegment": google_cloud_videointelligence_v1p2beta1_video_segment "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_VideoSegment/endTimeOffset": end_time_offset "/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_VideoSegment/startTimeOffset": start_time_offset +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_WordInfo": google_cloud_videointelligence_v1p2beta1_word_info +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_WordInfo/confidence": confidence +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_WordInfo/endTime": end_time +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_WordInfo/speakerTag": speaker_tag +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_WordInfo/startTime": start_time +"/videointelligence:v1p1beta1/GoogleCloudVideointelligenceV1p2beta1_WordInfo/word": word "/videointelligence:v1p1beta1/GoogleLongrunning_Operation": google_longrunning_operation "/videointelligence:v1p1beta1/GoogleLongrunning_Operation/done": done "/videointelligence:v1p1beta1/GoogleLongrunning_Operation/error": error @@ -90215,6 +91334,8 @@ "/videointelligence:v1p1beta1/key": key "/videointelligence:v1p1beta1/quotaUser": quota_user "/videointelligence:v1p1beta1/videointelligence.videos.annotate": annotate_video +"/vision:v1/AddProductToProductSetRequest": add_product_to_product_set_request +"/vision:v1/AddProductToProductSetRequest/product": product "/vision:v1/AnnotateFileResponse": annotate_file_response "/vision:v1/AnnotateFileResponse/inputConfig": input_config "/vision:v1/AnnotateFileResponse/responses": responses @@ -90240,6 +91361,7 @@ "/vision:v1/AnnotateImageResponse/localizedObjectAnnotations/localized_object_annotation": localized_object_annotation "/vision:v1/AnnotateImageResponse/logoAnnotations": logo_annotations "/vision:v1/AnnotateImageResponse/logoAnnotations/logo_annotation": logo_annotation +"/vision:v1/AnnotateImageResponse/productSearchResults": product_search_results "/vision:v1/AnnotateImageResponse/safeSearchAnnotation": safe_search_annotation "/vision:v1/AnnotateImageResponse/textAnnotations": text_annotations "/vision:v1/AnnotateImageResponse/textAnnotations/text_annotation": text_annotation @@ -90264,6 +91386,10 @@ "/vision:v1/BatchAnnotateImagesResponse": batch_annotate_images_response "/vision:v1/BatchAnnotateImagesResponse/responses": responses "/vision:v1/BatchAnnotateImagesResponse/responses/response": response +"/vision:v1/BatchOperationMetadata": batch_operation_metadata +"/vision:v1/BatchOperationMetadata/endTime": end_time +"/vision:v1/BatchOperationMetadata/state": state +"/vision:v1/BatchOperationMetadata/submitTime": submit_time "/vision:v1/Block": block "/vision:v1/Block/blockType": block_type "/vision:v1/Block/boundingBox": bounding_box @@ -90541,6 +91667,7 @@ "/vision:v1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/localizedObjectAnnotations/localized_object_annotation": localized_object_annotation "/vision:v1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/logoAnnotations": logo_annotations "/vision:v1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/logoAnnotations/logo_annotation": logo_annotation +"/vision:v1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/productSearchResults": product_search_results "/vision:v1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/safeSearchAnnotation": safe_search_annotation "/vision:v1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/textAnnotations": text_annotations "/vision:v1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/textAnnotations/text_annotation": text_annotation @@ -90650,6 +91777,30 @@ "/vision:v1/GoogleCloudVisionV1p1beta1Position/x": x "/vision:v1/GoogleCloudVisionV1p1beta1Position/y": y "/vision:v1/GoogleCloudVisionV1p1beta1Position/z": z +"/vision:v1/GoogleCloudVisionV1p1beta1Product": google_cloud_vision_v1p1beta1_product +"/vision:v1/GoogleCloudVisionV1p1beta1Product/description": description +"/vision:v1/GoogleCloudVisionV1p1beta1Product/displayName": display_name +"/vision:v1/GoogleCloudVisionV1p1beta1Product/name": name +"/vision:v1/GoogleCloudVisionV1p1beta1Product/productCategory": product_category +"/vision:v1/GoogleCloudVisionV1p1beta1Product/productLabels": product_labels +"/vision:v1/GoogleCloudVisionV1p1beta1Product/productLabels/product_label": product_label +"/vision:v1/GoogleCloudVisionV1p1beta1ProductKeyValue": google_cloud_vision_v1p1beta1_product_key_value +"/vision:v1/GoogleCloudVisionV1p1beta1ProductKeyValue/key": key +"/vision:v1/GoogleCloudVisionV1p1beta1ProductKeyValue/value": value +"/vision:v1/GoogleCloudVisionV1p1beta1ProductSearchResults": google_cloud_vision_v1p1beta1_product_search_results +"/vision:v1/GoogleCloudVisionV1p1beta1ProductSearchResults/indexTime": index_time +"/vision:v1/GoogleCloudVisionV1p1beta1ProductSearchResults/productGroupedResults": product_grouped_results +"/vision:v1/GoogleCloudVisionV1p1beta1ProductSearchResults/productGroupedResults/product_grouped_result": product_grouped_result +"/vision:v1/GoogleCloudVisionV1p1beta1ProductSearchResults/results": results +"/vision:v1/GoogleCloudVisionV1p1beta1ProductSearchResults/results/result": result +"/vision:v1/GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult": google_cloud_vision_v1p1beta1_product_search_results_grouped_result +"/vision:v1/GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult/boundingPoly": bounding_poly +"/vision:v1/GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult/results": results +"/vision:v1/GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult/results/result": result +"/vision:v1/GoogleCloudVisionV1p1beta1ProductSearchResultsResult": google_cloud_vision_v1p1beta1_product_search_results_result +"/vision:v1/GoogleCloudVisionV1p1beta1ProductSearchResultsResult/image": image +"/vision:v1/GoogleCloudVisionV1p1beta1ProductSearchResultsResult/product": product +"/vision:v1/GoogleCloudVisionV1p1beta1ProductSearchResultsResult/score": score "/vision:v1/GoogleCloudVisionV1p1beta1Property": google_cloud_vision_v1p1beta1_property "/vision:v1/GoogleCloudVisionV1p1beta1Property/name": name "/vision:v1/GoogleCloudVisionV1p1beta1Property/uint64Value": uint64_value @@ -90739,6 +91890,7 @@ "/vision:v1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/localizedObjectAnnotations/localized_object_annotation": localized_object_annotation "/vision:v1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/logoAnnotations": logo_annotations "/vision:v1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/logoAnnotations/logo_annotation": logo_annotation +"/vision:v1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/productSearchResults": product_search_results "/vision:v1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/safeSearchAnnotation": safe_search_annotation "/vision:v1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/textAnnotations": text_annotations "/vision:v1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/textAnnotations/text_annotation": text_annotation @@ -90855,6 +92007,30 @@ "/vision:v1/GoogleCloudVisionV1p2beta1Position/x": x "/vision:v1/GoogleCloudVisionV1p2beta1Position/y": y "/vision:v1/GoogleCloudVisionV1p2beta1Position/z": z +"/vision:v1/GoogleCloudVisionV1p2beta1Product": google_cloud_vision_v1p2beta1_product +"/vision:v1/GoogleCloudVisionV1p2beta1Product/description": description +"/vision:v1/GoogleCloudVisionV1p2beta1Product/displayName": display_name +"/vision:v1/GoogleCloudVisionV1p2beta1Product/name": name +"/vision:v1/GoogleCloudVisionV1p2beta1Product/productCategory": product_category +"/vision:v1/GoogleCloudVisionV1p2beta1Product/productLabels": product_labels +"/vision:v1/GoogleCloudVisionV1p2beta1Product/productLabels/product_label": product_label +"/vision:v1/GoogleCloudVisionV1p2beta1ProductKeyValue": google_cloud_vision_v1p2beta1_product_key_value +"/vision:v1/GoogleCloudVisionV1p2beta1ProductKeyValue/key": key +"/vision:v1/GoogleCloudVisionV1p2beta1ProductKeyValue/value": value +"/vision:v1/GoogleCloudVisionV1p2beta1ProductSearchResults": google_cloud_vision_v1p2beta1_product_search_results +"/vision:v1/GoogleCloudVisionV1p2beta1ProductSearchResults/indexTime": index_time +"/vision:v1/GoogleCloudVisionV1p2beta1ProductSearchResults/productGroupedResults": product_grouped_results +"/vision:v1/GoogleCloudVisionV1p2beta1ProductSearchResults/productGroupedResults/product_grouped_result": product_grouped_result +"/vision:v1/GoogleCloudVisionV1p2beta1ProductSearchResults/results": results +"/vision:v1/GoogleCloudVisionV1p2beta1ProductSearchResults/results/result": result +"/vision:v1/GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult": google_cloud_vision_v1p2beta1_product_search_results_grouped_result +"/vision:v1/GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult/boundingPoly": bounding_poly +"/vision:v1/GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult/results": results +"/vision:v1/GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult/results/result": result +"/vision:v1/GoogleCloudVisionV1p2beta1ProductSearchResultsResult": google_cloud_vision_v1p2beta1_product_search_results_result +"/vision:v1/GoogleCloudVisionV1p2beta1ProductSearchResultsResult/image": image +"/vision:v1/GoogleCloudVisionV1p2beta1ProductSearchResultsResult/product": product +"/vision:v1/GoogleCloudVisionV1p2beta1ProductSearchResultsResult/score": score "/vision:v1/GoogleCloudVisionV1p2beta1Property": google_cloud_vision_v1p2beta1_property "/vision:v1/GoogleCloudVisionV1p2beta1Property/name": name "/vision:v1/GoogleCloudVisionV1p2beta1Property/uint64Value": uint64_value @@ -91080,8 +92256,14 @@ "/vision:v1/GoogleCloudVisionV1p3beta1ProductKeyValue/value": value "/vision:v1/GoogleCloudVisionV1p3beta1ProductSearchResults": google_cloud_vision_v1p3beta1_product_search_results "/vision:v1/GoogleCloudVisionV1p3beta1ProductSearchResults/indexTime": index_time +"/vision:v1/GoogleCloudVisionV1p3beta1ProductSearchResults/productGroupedResults": product_grouped_results +"/vision:v1/GoogleCloudVisionV1p3beta1ProductSearchResults/productGroupedResults/product_grouped_result": product_grouped_result "/vision:v1/GoogleCloudVisionV1p3beta1ProductSearchResults/results": results "/vision:v1/GoogleCloudVisionV1p3beta1ProductSearchResults/results/result": result +"/vision:v1/GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult": google_cloud_vision_v1p3beta1_product_search_results_grouped_result +"/vision:v1/GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult/boundingPoly": bounding_poly +"/vision:v1/GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult/results": results +"/vision:v1/GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult/results/result": result "/vision:v1/GoogleCloudVisionV1p3beta1ProductSearchResultsResult": google_cloud_vision_v1p3beta1_product_search_results_result "/vision:v1/GoogleCloudVisionV1p3beta1ProductSearchResultsResult/image": image "/vision:v1/GoogleCloudVisionV1p3beta1ProductSearchResultsResult/product": product @@ -91174,6 +92356,10 @@ "/vision:v1/GoogleTypeLatLng": google_type_lat_lng "/vision:v1/GoogleTypeLatLng/latitude": latitude "/vision:v1/GoogleTypeLatLng/longitude": longitude +"/vision:v1/GroupedResult": grouped_result +"/vision:v1/GroupedResult/boundingPoly": bounding_poly +"/vision:v1/GroupedResult/results": results +"/vision:v1/GroupedResult/results/result": result "/vision:v1/Image": image "/vision:v1/Image/content": content "/vision:v1/Image/source": source @@ -91185,15 +92371,30 @@ "/vision:v1/ImageContext/languageHints": language_hints "/vision:v1/ImageContext/languageHints/language_hint": language_hint "/vision:v1/ImageContext/latLongRect": lat_long_rect +"/vision:v1/ImageContext/productSearchParams": product_search_params "/vision:v1/ImageContext/webDetectionParams": web_detection_params "/vision:v1/ImageProperties": image_properties "/vision:v1/ImageProperties/dominantColors": dominant_colors "/vision:v1/ImageSource": image_source "/vision:v1/ImageSource/gcsImageUri": gcs_image_uri "/vision:v1/ImageSource/imageUri": image_uri +"/vision:v1/ImportProductSetsGcsSource": import_product_sets_gcs_source +"/vision:v1/ImportProductSetsGcsSource/csvFileUri": csv_file_uri +"/vision:v1/ImportProductSetsInputConfig": import_product_sets_input_config +"/vision:v1/ImportProductSetsInputConfig/gcsSource": gcs_source +"/vision:v1/ImportProductSetsRequest": import_product_sets_request +"/vision:v1/ImportProductSetsRequest/inputConfig": input_config +"/vision:v1/ImportProductSetsResponse": import_product_sets_response +"/vision:v1/ImportProductSetsResponse/referenceImages": reference_images +"/vision:v1/ImportProductSetsResponse/referenceImages/reference_image": reference_image +"/vision:v1/ImportProductSetsResponse/statuses": statuses +"/vision:v1/ImportProductSetsResponse/statuses/status": status "/vision:v1/InputConfig": input_config "/vision:v1/InputConfig/gcsSource": gcs_source "/vision:v1/InputConfig/mimeType": mime_type +"/vision:v1/KeyValue": key_value +"/vision:v1/KeyValue/key": key +"/vision:v1/KeyValue/value": value "/vision:v1/Landmark": landmark "/vision:v1/Landmark/position": position "/vision:v1/Landmark/type": type @@ -91207,6 +92408,23 @@ "/vision:v1/ListOperationsResponse/nextPageToken": next_page_token "/vision:v1/ListOperationsResponse/operations": operations "/vision:v1/ListOperationsResponse/operations/operation": operation +"/vision:v1/ListProductSetsResponse": list_product_sets_response +"/vision:v1/ListProductSetsResponse/nextPageToken": next_page_token +"/vision:v1/ListProductSetsResponse/productSets": product_sets +"/vision:v1/ListProductSetsResponse/productSets/product_set": product_set +"/vision:v1/ListProductsInProductSetResponse": list_products_in_product_set_response +"/vision:v1/ListProductsInProductSetResponse/nextPageToken": next_page_token +"/vision:v1/ListProductsInProductSetResponse/products": products +"/vision:v1/ListProductsInProductSetResponse/products/product": product +"/vision:v1/ListProductsResponse": list_products_response +"/vision:v1/ListProductsResponse/nextPageToken": next_page_token +"/vision:v1/ListProductsResponse/products": products +"/vision:v1/ListProductsResponse/products/product": product +"/vision:v1/ListReferenceImagesResponse": list_reference_images_response +"/vision:v1/ListReferenceImagesResponse/nextPageToken": next_page_token +"/vision:v1/ListReferenceImagesResponse/pageSize": page_size +"/vision:v1/ListReferenceImagesResponse/referenceImages": reference_images +"/vision:v1/ListReferenceImagesResponse/referenceImages/reference_image": reference_image "/vision:v1/LocalizedObjectAnnotation": localized_object_annotation "/vision:v1/LocalizedObjectAnnotation/boundingPoly": bounding_poly "/vision:v1/LocalizedObjectAnnotation/languageCode": language_code @@ -91250,10 +92468,45 @@ "/vision:v1/Position/x": x "/vision:v1/Position/y": y "/vision:v1/Position/z": z +"/vision:v1/Product": product +"/vision:v1/Product/description": description +"/vision:v1/Product/displayName": display_name +"/vision:v1/Product/name": name +"/vision:v1/Product/productCategory": product_category +"/vision:v1/Product/productLabels": product_labels +"/vision:v1/Product/productLabels/product_label": product_label +"/vision:v1/ProductSearchParams": product_search_params +"/vision:v1/ProductSearchParams/boundingPoly": bounding_poly +"/vision:v1/ProductSearchParams/filter": filter +"/vision:v1/ProductSearchParams/productCategories": product_categories +"/vision:v1/ProductSearchParams/productCategories/product_category": product_category +"/vision:v1/ProductSearchParams/productSet": product_set +"/vision:v1/ProductSearchResults": product_search_results +"/vision:v1/ProductSearchResults/indexTime": index_time +"/vision:v1/ProductSearchResults/productGroupedResults": product_grouped_results +"/vision:v1/ProductSearchResults/productGroupedResults/product_grouped_result": product_grouped_result +"/vision:v1/ProductSearchResults/results": results +"/vision:v1/ProductSearchResults/results/result": result +"/vision:v1/ProductSet": product_set +"/vision:v1/ProductSet/displayName": display_name +"/vision:v1/ProductSet/indexError": index_error +"/vision:v1/ProductSet/indexTime": index_time +"/vision:v1/ProductSet/name": name "/vision:v1/Property": property "/vision:v1/Property/name": name "/vision:v1/Property/uint64Value": uint64_value "/vision:v1/Property/value": value +"/vision:v1/ReferenceImage": reference_image +"/vision:v1/ReferenceImage/boundingPolys": bounding_polys +"/vision:v1/ReferenceImage/boundingPolys/bounding_poly": bounding_poly +"/vision:v1/ReferenceImage/name": name +"/vision:v1/ReferenceImage/uri": uri +"/vision:v1/RemoveProductFromProductSetRequest": remove_product_from_product_set_request +"/vision:v1/RemoveProductFromProductSetRequest/product": product +"/vision:v1/Result": result +"/vision:v1/Result/image": image +"/vision:v1/Result/product": product +"/vision:v1/Result/score": score "/vision:v1/SafeSearchAnnotation": safe_search_annotation "/vision:v1/SafeSearchAnnotation/adult": adult "/vision:v1/SafeSearchAnnotation/medical": medical @@ -91339,6 +92592,55 @@ "/vision:v1/vision.operations.list/name": name "/vision:v1/vision.operations.list/pageSize": page_size "/vision:v1/vision.operations.list/pageToken": page_token +"/vision:v1/vision.projects.locations.productSets.addProduct": add_product_to_product_set +"/vision:v1/vision.projects.locations.productSets.addProduct/name": name +"/vision:v1/vision.projects.locations.productSets.create": create_project_location_product_set +"/vision:v1/vision.projects.locations.productSets.create/parent": parent +"/vision:v1/vision.projects.locations.productSets.create/productSetId": product_set_id +"/vision:v1/vision.projects.locations.productSets.delete": delete_project_location_product_set +"/vision:v1/vision.projects.locations.productSets.delete/name": name +"/vision:v1/vision.projects.locations.productSets.get": get_project_location_product_set +"/vision:v1/vision.projects.locations.productSets.get/name": name +"/vision:v1/vision.projects.locations.productSets.import": import_product_sets +"/vision:v1/vision.projects.locations.productSets.import/parent": parent +"/vision:v1/vision.projects.locations.productSets.list": list_project_location_product_sets +"/vision:v1/vision.projects.locations.productSets.list/pageSize": page_size +"/vision:v1/vision.projects.locations.productSets.list/pageToken": page_token +"/vision:v1/vision.projects.locations.productSets.list/parent": parent +"/vision:v1/vision.projects.locations.productSets.patch": patch_project_location_product_set +"/vision:v1/vision.projects.locations.productSets.patch/name": name +"/vision:v1/vision.projects.locations.productSets.patch/updateMask": update_mask +"/vision:v1/vision.projects.locations.productSets.products.list": list_project_location_product_set_products +"/vision:v1/vision.projects.locations.productSets.products.list/name": name +"/vision:v1/vision.projects.locations.productSets.products.list/pageSize": page_size +"/vision:v1/vision.projects.locations.productSets.products.list/pageToken": page_token +"/vision:v1/vision.projects.locations.productSets.removeProduct": remove_product_from_product_set +"/vision:v1/vision.projects.locations.productSets.removeProduct/name": name +"/vision:v1/vision.projects.locations.products.create": create_project_location_product +"/vision:v1/vision.projects.locations.products.create/parent": parent +"/vision:v1/vision.projects.locations.products.create/productId": product_id +"/vision:v1/vision.projects.locations.products.delete": delete_project_location_product +"/vision:v1/vision.projects.locations.products.delete/name": name +"/vision:v1/vision.projects.locations.products.get": get_project_location_product +"/vision:v1/vision.projects.locations.products.get/name": name +"/vision:v1/vision.projects.locations.products.list": list_project_location_products +"/vision:v1/vision.projects.locations.products.list/pageSize": page_size +"/vision:v1/vision.projects.locations.products.list/pageToken": page_token +"/vision:v1/vision.projects.locations.products.list/parent": parent +"/vision:v1/vision.projects.locations.products.patch": patch_project_location_product +"/vision:v1/vision.projects.locations.products.patch/name": name +"/vision:v1/vision.projects.locations.products.patch/updateMask": update_mask +"/vision:v1/vision.projects.locations.products.referenceImages.create": create_project_location_product_reference_image +"/vision:v1/vision.projects.locations.products.referenceImages.create/parent": parent +"/vision:v1/vision.projects.locations.products.referenceImages.create/referenceImageId": reference_image_id +"/vision:v1/vision.projects.locations.products.referenceImages.delete": delete_project_location_product_reference_image +"/vision:v1/vision.projects.locations.products.referenceImages.delete/name": name +"/vision:v1/vision.projects.locations.products.referenceImages.get": get_project_location_product_reference_image +"/vision:v1/vision.projects.locations.products.referenceImages.get/name": name +"/vision:v1/vision.projects.locations.products.referenceImages.list": list_project_location_product_reference_images +"/vision:v1/vision.projects.locations.products.referenceImages.list/pageSize": page_size +"/vision:v1/vision.projects.locations.products.referenceImages.list/pageToken": page_token +"/vision:v1/vision.projects.locations.products.referenceImages.list/parent": parent "/vision:v1p1beta1/AnnotateFileResponse": annotate_file_response "/vision:v1p1beta1/AnnotateFileResponse/inputConfig": input_config "/vision:v1p1beta1/AnnotateFileResponse/responses": responses @@ -91359,6 +92661,7 @@ "/vision:v1p1beta1/AnnotateImageResponse/localizedObjectAnnotations/localized_object_annotation": localized_object_annotation "/vision:v1p1beta1/AnnotateImageResponse/logoAnnotations": logo_annotations "/vision:v1p1beta1/AnnotateImageResponse/logoAnnotations/logo_annotation": logo_annotation +"/vision:v1p1beta1/AnnotateImageResponse/productSearchResults": product_search_results "/vision:v1p1beta1/AnnotateImageResponse/safeSearchAnnotation": safe_search_annotation "/vision:v1p1beta1/AnnotateImageResponse/textAnnotations": text_annotations "/vision:v1p1beta1/AnnotateImageResponse/textAnnotations/text_annotation": text_annotation @@ -91368,6 +92671,10 @@ "/vision:v1p1beta1/AsyncBatchAnnotateFilesResponse": async_batch_annotate_files_response "/vision:v1p1beta1/AsyncBatchAnnotateFilesResponse/responses": responses "/vision:v1p1beta1/AsyncBatchAnnotateFilesResponse/responses/response": response +"/vision:v1p1beta1/BatchOperationMetadata": batch_operation_metadata +"/vision:v1p1beta1/BatchOperationMetadata/endTime": end_time +"/vision:v1p1beta1/BatchOperationMetadata/state": state +"/vision:v1p1beta1/BatchOperationMetadata/submitTime": submit_time "/vision:v1p1beta1/Block": block "/vision:v1p1beta1/Block/blockType": block_type "/vision:v1p1beta1/Block/boundingBox": bounding_box @@ -91463,6 +92770,7 @@ "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/localizedObjectAnnotations/localized_object_annotation": localized_object_annotation "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/logoAnnotations": logo_annotations "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/logoAnnotations/logo_annotation": logo_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/productSearchResults": product_search_results "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/safeSearchAnnotation": safe_search_annotation "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/textAnnotations": text_annotations "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/textAnnotations/text_annotation": text_annotation @@ -91565,6 +92873,7 @@ "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageContext/languageHints": language_hints "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageContext/languageHints/language_hint": language_hint "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageContext/latLongRect": lat_long_rect +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageContext/productSearchParams": product_search_params "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageContext/webDetectionParams": web_detection_params "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageProperties": google_cloud_vision_v1p1beta1_image_properties "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ImageProperties/dominantColors": dominant_colors @@ -91609,6 +92918,36 @@ "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Position/x": x "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Position/y": y "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Position/z": z +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Product": google_cloud_vision_v1p1beta1_product +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Product/description": description +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Product/displayName": display_name +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Product/name": name +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Product/productCategory": product_category +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Product/productLabels": product_labels +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Product/productLabels/product_label": product_label +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductKeyValue": google_cloud_vision_v1p1beta1_product_key_value +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductKeyValue/key": key +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductKeyValue/value": value +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchParams": google_cloud_vision_v1p1beta1_product_search_params +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchParams/boundingPoly": bounding_poly +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchParams/filter": filter +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchParams/productCategories": product_categories +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchParams/productCategories/product_category": product_category +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchParams/productSet": product_set +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchResults": google_cloud_vision_v1p1beta1_product_search_results +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchResults/indexTime": index_time +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchResults/productGroupedResults": product_grouped_results +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchResults/productGroupedResults/product_grouped_result": product_grouped_result +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchResults/results": results +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchResults/results/result": result +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult": google_cloud_vision_v1p1beta1_product_search_results_grouped_result +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult/boundingPoly": bounding_poly +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult/results": results +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult/results/result": result +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsResult": google_cloud_vision_v1p1beta1_product_search_results_result +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsResult/image": image +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsResult/product": product +"/vision:v1p1beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsResult/score": score "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Property": google_cloud_vision_v1p1beta1_property "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Property/name": name "/vision:v1p1beta1/GoogleCloudVisionV1p1beta1Property/uint64Value": uint64_value @@ -91700,6 +93039,7 @@ "/vision:v1p1beta1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/localizedObjectAnnotations/localized_object_annotation": localized_object_annotation "/vision:v1p1beta1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/logoAnnotations": logo_annotations "/vision:v1p1beta1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/logoAnnotations/logo_annotation": logo_annotation +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/productSearchResults": product_search_results "/vision:v1p1beta1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/safeSearchAnnotation": safe_search_annotation "/vision:v1p1beta1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/textAnnotations": text_annotations "/vision:v1p1beta1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/textAnnotations/text_annotation": text_annotation @@ -91816,6 +93156,30 @@ "/vision:v1p1beta1/GoogleCloudVisionV1p2beta1Position/x": x "/vision:v1p1beta1/GoogleCloudVisionV1p2beta1Position/y": y "/vision:v1p1beta1/GoogleCloudVisionV1p2beta1Position/z": z +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1Product": google_cloud_vision_v1p2beta1_product +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1Product/description": description +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1Product/displayName": display_name +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1Product/name": name +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1Product/productCategory": product_category +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1Product/productLabels": product_labels +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1Product/productLabels/product_label": product_label +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductKeyValue": google_cloud_vision_v1p2beta1_product_key_value +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductKeyValue/key": key +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductKeyValue/value": value +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductSearchResults": google_cloud_vision_v1p2beta1_product_search_results +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductSearchResults/indexTime": index_time +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductSearchResults/productGroupedResults": product_grouped_results +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductSearchResults/productGroupedResults/product_grouped_result": product_grouped_result +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductSearchResults/results": results +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductSearchResults/results/result": result +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult": google_cloud_vision_v1p2beta1_product_search_results_grouped_result +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult/boundingPoly": bounding_poly +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult/results": results +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult/results/result": result +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsResult": google_cloud_vision_v1p2beta1_product_search_results_result +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsResult/image": image +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsResult/product": product +"/vision:v1p1beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsResult/score": score "/vision:v1p1beta1/GoogleCloudVisionV1p2beta1Property": google_cloud_vision_v1p2beta1_property "/vision:v1p1beta1/GoogleCloudVisionV1p2beta1Property/name": name "/vision:v1p1beta1/GoogleCloudVisionV1p2beta1Property/uint64Value": uint64_value @@ -92041,8 +93405,14 @@ "/vision:v1p1beta1/GoogleCloudVisionV1p3beta1ProductKeyValue/value": value "/vision:v1p1beta1/GoogleCloudVisionV1p3beta1ProductSearchResults": google_cloud_vision_v1p3beta1_product_search_results "/vision:v1p1beta1/GoogleCloudVisionV1p3beta1ProductSearchResults/indexTime": index_time +"/vision:v1p1beta1/GoogleCloudVisionV1p3beta1ProductSearchResults/productGroupedResults": product_grouped_results +"/vision:v1p1beta1/GoogleCloudVisionV1p3beta1ProductSearchResults/productGroupedResults/product_grouped_result": product_grouped_result "/vision:v1p1beta1/GoogleCloudVisionV1p3beta1ProductSearchResults/results": results "/vision:v1p1beta1/GoogleCloudVisionV1p3beta1ProductSearchResults/results/result": result +"/vision:v1p1beta1/GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult": google_cloud_vision_v1p3beta1_product_search_results_grouped_result +"/vision:v1p1beta1/GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult/boundingPoly": bounding_poly +"/vision:v1p1beta1/GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult/results": results +"/vision:v1p1beta1/GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult/results/result": result "/vision:v1p1beta1/GoogleCloudVisionV1p3beta1ProductSearchResultsResult": google_cloud_vision_v1p3beta1_product_search_results_result "/vision:v1p1beta1/GoogleCloudVisionV1p3beta1ProductSearchResultsResult/image": image "/vision:v1p1beta1/GoogleCloudVisionV1p3beta1ProductSearchResultsResult/product": product @@ -92135,14 +93505,26 @@ "/vision:v1p1beta1/GoogleTypeLatLng": google_type_lat_lng "/vision:v1p1beta1/GoogleTypeLatLng/latitude": latitude "/vision:v1p1beta1/GoogleTypeLatLng/longitude": longitude +"/vision:v1p1beta1/GroupedResult": grouped_result +"/vision:v1p1beta1/GroupedResult/boundingPoly": bounding_poly +"/vision:v1p1beta1/GroupedResult/results": results +"/vision:v1p1beta1/GroupedResult/results/result": result "/vision:v1p1beta1/ImageAnnotationContext": image_annotation_context "/vision:v1p1beta1/ImageAnnotationContext/pageNumber": page_number "/vision:v1p1beta1/ImageAnnotationContext/uri": uri "/vision:v1p1beta1/ImageProperties": image_properties "/vision:v1p1beta1/ImageProperties/dominantColors": dominant_colors +"/vision:v1p1beta1/ImportProductSetsResponse": import_product_sets_response +"/vision:v1p1beta1/ImportProductSetsResponse/referenceImages": reference_images +"/vision:v1p1beta1/ImportProductSetsResponse/referenceImages/reference_image": reference_image +"/vision:v1p1beta1/ImportProductSetsResponse/statuses": statuses +"/vision:v1p1beta1/ImportProductSetsResponse/statuses/status": status "/vision:v1p1beta1/InputConfig": input_config "/vision:v1p1beta1/InputConfig/gcsSource": gcs_source "/vision:v1p1beta1/InputConfig/mimeType": mime_type +"/vision:v1p1beta1/KeyValue": key_value +"/vision:v1p1beta1/KeyValue/key": key +"/vision:v1p1beta1/KeyValue/value": value "/vision:v1p1beta1/Landmark": landmark "/vision:v1p1beta1/Landmark/position": position "/vision:v1p1beta1/Landmark/type": type @@ -92192,10 +93574,32 @@ "/vision:v1p1beta1/Position/x": x "/vision:v1p1beta1/Position/y": y "/vision:v1p1beta1/Position/z": z +"/vision:v1p1beta1/Product": product +"/vision:v1p1beta1/Product/description": description +"/vision:v1p1beta1/Product/displayName": display_name +"/vision:v1p1beta1/Product/name": name +"/vision:v1p1beta1/Product/productCategory": product_category +"/vision:v1p1beta1/Product/productLabels": product_labels +"/vision:v1p1beta1/Product/productLabels/product_label": product_label +"/vision:v1p1beta1/ProductSearchResults": product_search_results +"/vision:v1p1beta1/ProductSearchResults/indexTime": index_time +"/vision:v1p1beta1/ProductSearchResults/productGroupedResults": product_grouped_results +"/vision:v1p1beta1/ProductSearchResults/productGroupedResults/product_grouped_result": product_grouped_result +"/vision:v1p1beta1/ProductSearchResults/results": results +"/vision:v1p1beta1/ProductSearchResults/results/result": result "/vision:v1p1beta1/Property": property "/vision:v1p1beta1/Property/name": name "/vision:v1p1beta1/Property/uint64Value": uint64_value "/vision:v1p1beta1/Property/value": value +"/vision:v1p1beta1/ReferenceImage": reference_image +"/vision:v1p1beta1/ReferenceImage/boundingPolys": bounding_polys +"/vision:v1p1beta1/ReferenceImage/boundingPolys/bounding_poly": bounding_poly +"/vision:v1p1beta1/ReferenceImage/name": name +"/vision:v1p1beta1/ReferenceImage/uri": uri +"/vision:v1p1beta1/Result": result +"/vision:v1p1beta1/Result/image": image +"/vision:v1p1beta1/Result/product": product +"/vision:v1p1beta1/Result/score": score "/vision:v1p1beta1/SafeSearchAnnotation": safe_search_annotation "/vision:v1p1beta1/SafeSearchAnnotation/adult": adult "/vision:v1p1beta1/SafeSearchAnnotation/medical": medical @@ -92286,6 +93690,7 @@ "/vision:v1p2beta1/AnnotateImageResponse/localizedObjectAnnotations/localized_object_annotation": localized_object_annotation "/vision:v1p2beta1/AnnotateImageResponse/logoAnnotations": logo_annotations "/vision:v1p2beta1/AnnotateImageResponse/logoAnnotations/logo_annotation": logo_annotation +"/vision:v1p2beta1/AnnotateImageResponse/productSearchResults": product_search_results "/vision:v1p2beta1/AnnotateImageResponse/safeSearchAnnotation": safe_search_annotation "/vision:v1p2beta1/AnnotateImageResponse/textAnnotations": text_annotations "/vision:v1p2beta1/AnnotateImageResponse/textAnnotations/text_annotation": text_annotation @@ -92295,6 +93700,10 @@ "/vision:v1p2beta1/AsyncBatchAnnotateFilesResponse": async_batch_annotate_files_response "/vision:v1p2beta1/AsyncBatchAnnotateFilesResponse/responses": responses "/vision:v1p2beta1/AsyncBatchAnnotateFilesResponse/responses/response": response +"/vision:v1p2beta1/BatchOperationMetadata": batch_operation_metadata +"/vision:v1p2beta1/BatchOperationMetadata/endTime": end_time +"/vision:v1p2beta1/BatchOperationMetadata/state": state +"/vision:v1p2beta1/BatchOperationMetadata/submitTime": submit_time "/vision:v1p2beta1/Block": block "/vision:v1p2beta1/Block/blockType": block_type "/vision:v1p2beta1/Block/boundingBox": bounding_box @@ -92385,6 +93794,7 @@ "/vision:v1p2beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/localizedObjectAnnotations/localized_object_annotation": localized_object_annotation "/vision:v1p2beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/logoAnnotations": logo_annotations "/vision:v1p2beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/logoAnnotations/logo_annotation": logo_annotation +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/productSearchResults": product_search_results "/vision:v1p2beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/safeSearchAnnotation": safe_search_annotation "/vision:v1p2beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/textAnnotations": text_annotations "/vision:v1p2beta1/GoogleCloudVisionV1p1beta1AnnotateImageResponse/textAnnotations/text_annotation": text_annotation @@ -92494,6 +93904,30 @@ "/vision:v1p2beta1/GoogleCloudVisionV1p1beta1Position/x": x "/vision:v1p2beta1/GoogleCloudVisionV1p1beta1Position/y": y "/vision:v1p2beta1/GoogleCloudVisionV1p1beta1Position/z": z +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1Product": google_cloud_vision_v1p1beta1_product +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1Product/description": description +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1Product/displayName": display_name +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1Product/name": name +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1Product/productCategory": product_category +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1Product/productLabels": product_labels +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1Product/productLabels/product_label": product_label +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductKeyValue": google_cloud_vision_v1p1beta1_product_key_value +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductKeyValue/key": key +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductKeyValue/value": value +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductSearchResults": google_cloud_vision_v1p1beta1_product_search_results +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductSearchResults/indexTime": index_time +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductSearchResults/productGroupedResults": product_grouped_results +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductSearchResults/productGroupedResults/product_grouped_result": product_grouped_result +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductSearchResults/results": results +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductSearchResults/results/result": result +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult": google_cloud_vision_v1p1beta1_product_search_results_grouped_result +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult/boundingPoly": bounding_poly +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult/results": results +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult/results/result": result +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsResult": google_cloud_vision_v1p1beta1_product_search_results_result +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsResult/image": image +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsResult/product": product +"/vision:v1p2beta1/GoogleCloudVisionV1p1beta1ProductSearchResultsResult/score": score "/vision:v1p2beta1/GoogleCloudVisionV1p1beta1Property": google_cloud_vision_v1p1beta1_property "/vision:v1p2beta1/GoogleCloudVisionV1p1beta1Property/name": name "/vision:v1p2beta1/GoogleCloudVisionV1p1beta1Property/uint64Value": uint64_value @@ -92588,6 +94022,7 @@ "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/localizedObjectAnnotations/localized_object_annotation": localized_object_annotation "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/logoAnnotations": logo_annotations "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/logoAnnotations/logo_annotation": logo_annotation +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/productSearchResults": product_search_results "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/safeSearchAnnotation": safe_search_annotation "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/textAnnotations": text_annotations "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1AnnotateImageResponse/textAnnotations/text_annotation": text_annotation @@ -92694,6 +94129,7 @@ "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ImageContext/languageHints": language_hints "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ImageContext/languageHints/language_hint": language_hint "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ImageContext/latLongRect": lat_long_rect +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ImageContext/productSearchParams": product_search_params "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ImageContext/webDetectionParams": web_detection_params "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ImageProperties": google_cloud_vision_v1p2beta1_image_properties "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ImageProperties/dominantColors": dominant_colors @@ -92741,6 +94177,36 @@ "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1Position/x": x "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1Position/y": y "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1Position/z": z +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1Product": google_cloud_vision_v1p2beta1_product +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1Product/description": description +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1Product/displayName": display_name +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1Product/name": name +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1Product/productCategory": product_category +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1Product/productLabels": product_labels +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1Product/productLabels/product_label": product_label +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductKeyValue": google_cloud_vision_v1p2beta1_product_key_value +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductKeyValue/key": key +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductKeyValue/value": value +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchParams": google_cloud_vision_v1p2beta1_product_search_params +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchParams/boundingPoly": bounding_poly +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchParams/filter": filter +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchParams/productCategories": product_categories +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchParams/productCategories/product_category": product_category +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchParams/productSet": product_set +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchResults": google_cloud_vision_v1p2beta1_product_search_results +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchResults/indexTime": index_time +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchResults/productGroupedResults": product_grouped_results +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchResults/productGroupedResults/product_grouped_result": product_grouped_result +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchResults/results": results +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchResults/results/result": result +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult": google_cloud_vision_v1p2beta1_product_search_results_grouped_result +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult/boundingPoly": bounding_poly +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult/results": results +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult/results/result": result +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsResult": google_cloud_vision_v1p2beta1_product_search_results_result +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsResult/image": image +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsResult/product": product +"/vision:v1p2beta1/GoogleCloudVisionV1p2beta1ProductSearchResultsResult/score": score "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1Property": google_cloud_vision_v1p2beta1_property "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1Property/name": name "/vision:v1p2beta1/GoogleCloudVisionV1p2beta1Property/uint64Value": uint64_value @@ -92968,8 +94434,14 @@ "/vision:v1p2beta1/GoogleCloudVisionV1p3beta1ProductKeyValue/value": value "/vision:v1p2beta1/GoogleCloudVisionV1p3beta1ProductSearchResults": google_cloud_vision_v1p3beta1_product_search_results "/vision:v1p2beta1/GoogleCloudVisionV1p3beta1ProductSearchResults/indexTime": index_time +"/vision:v1p2beta1/GoogleCloudVisionV1p3beta1ProductSearchResults/productGroupedResults": product_grouped_results +"/vision:v1p2beta1/GoogleCloudVisionV1p3beta1ProductSearchResults/productGroupedResults/product_grouped_result": product_grouped_result "/vision:v1p2beta1/GoogleCloudVisionV1p3beta1ProductSearchResults/results": results "/vision:v1p2beta1/GoogleCloudVisionV1p3beta1ProductSearchResults/results/result": result +"/vision:v1p2beta1/GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult": google_cloud_vision_v1p3beta1_product_search_results_grouped_result +"/vision:v1p2beta1/GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult/boundingPoly": bounding_poly +"/vision:v1p2beta1/GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult/results": results +"/vision:v1p2beta1/GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult/results/result": result "/vision:v1p2beta1/GoogleCloudVisionV1p3beta1ProductSearchResultsResult": google_cloud_vision_v1p3beta1_product_search_results_result "/vision:v1p2beta1/GoogleCloudVisionV1p3beta1ProductSearchResultsResult/image": image "/vision:v1p2beta1/GoogleCloudVisionV1p3beta1ProductSearchResultsResult/product": product @@ -93048,14 +94520,26 @@ "/vision:v1p2beta1/GoogleCloudVisionV1p3beta1Word/property": property "/vision:v1p2beta1/GoogleCloudVisionV1p3beta1Word/symbols": symbols "/vision:v1p2beta1/GoogleCloudVisionV1p3beta1Word/symbols/symbol": symbol +"/vision:v1p2beta1/GroupedResult": grouped_result +"/vision:v1p2beta1/GroupedResult/boundingPoly": bounding_poly +"/vision:v1p2beta1/GroupedResult/results": results +"/vision:v1p2beta1/GroupedResult/results/result": result "/vision:v1p2beta1/ImageAnnotationContext": image_annotation_context "/vision:v1p2beta1/ImageAnnotationContext/pageNumber": page_number "/vision:v1p2beta1/ImageAnnotationContext/uri": uri "/vision:v1p2beta1/ImageProperties": image_properties "/vision:v1p2beta1/ImageProperties/dominantColors": dominant_colors +"/vision:v1p2beta1/ImportProductSetsResponse": import_product_sets_response +"/vision:v1p2beta1/ImportProductSetsResponse/referenceImages": reference_images +"/vision:v1p2beta1/ImportProductSetsResponse/referenceImages/reference_image": reference_image +"/vision:v1p2beta1/ImportProductSetsResponse/statuses": statuses +"/vision:v1p2beta1/ImportProductSetsResponse/statuses/status": status "/vision:v1p2beta1/InputConfig": input_config "/vision:v1p2beta1/InputConfig/gcsSource": gcs_source "/vision:v1p2beta1/InputConfig/mimeType": mime_type +"/vision:v1p2beta1/KeyValue": key_value +"/vision:v1p2beta1/KeyValue/key": key +"/vision:v1p2beta1/KeyValue/value": value "/vision:v1p2beta1/Landmark": landmark "/vision:v1p2beta1/Landmark/position": position "/vision:v1p2beta1/Landmark/type": type @@ -93105,10 +94589,32 @@ "/vision:v1p2beta1/Position/x": x "/vision:v1p2beta1/Position/y": y "/vision:v1p2beta1/Position/z": z +"/vision:v1p2beta1/Product": product +"/vision:v1p2beta1/Product/description": description +"/vision:v1p2beta1/Product/displayName": display_name +"/vision:v1p2beta1/Product/name": name +"/vision:v1p2beta1/Product/productCategory": product_category +"/vision:v1p2beta1/Product/productLabels": product_labels +"/vision:v1p2beta1/Product/productLabels/product_label": product_label +"/vision:v1p2beta1/ProductSearchResults": product_search_results +"/vision:v1p2beta1/ProductSearchResults/indexTime": index_time +"/vision:v1p2beta1/ProductSearchResults/productGroupedResults": product_grouped_results +"/vision:v1p2beta1/ProductSearchResults/productGroupedResults/product_grouped_result": product_grouped_result +"/vision:v1p2beta1/ProductSearchResults/results": results +"/vision:v1p2beta1/ProductSearchResults/results/result": result "/vision:v1p2beta1/Property": property "/vision:v1p2beta1/Property/name": name "/vision:v1p2beta1/Property/uint64Value": uint64_value "/vision:v1p2beta1/Property/value": value +"/vision:v1p2beta1/ReferenceImage": reference_image +"/vision:v1p2beta1/ReferenceImage/boundingPolys": bounding_polys +"/vision:v1p2beta1/ReferenceImage/boundingPolys/bounding_poly": bounding_poly +"/vision:v1p2beta1/ReferenceImage/name": name +"/vision:v1p2beta1/ReferenceImage/uri": uri +"/vision:v1p2beta1/Result": result +"/vision:v1p2beta1/Result/image": image +"/vision:v1p2beta1/Result/product": product +"/vision:v1p2beta1/Result/score": score "/vision:v1p2beta1/SafeSearchAnnotation": safe_search_annotation "/vision:v1p2beta1/SafeSearchAnnotation/adult": adult "/vision:v1p2beta1/SafeSearchAnnotation/medical": medical diff --git a/generated/google/apis/adexchangebuyer2_v2beta1.rb b/generated/google/apis/adexchangebuyer2_v2beta1.rb index 2a4aa84ad..b5c54ff88 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://developers.google.com/authorized-buyers/apis/reference/rest/ module Adexchangebuyer2V2beta1 VERSION = 'V2beta1' - REVISION = '20181009' + REVISION = '20181024' # 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 8894a728d..0c1426384 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb @@ -1578,6 +1578,13 @@ module Google # @return [Google::Apis::Adexchangebuyer2V2beta1::AbsoluteDateRange] attr_accessor :absolute_date_range + # The set of dimensions along which to break down the response; may be empty. + # If multiple dimensions are requested, the breakdown is along the Cartesian + # product of the requested dimensions. + # Corresponds to the JSON property `breakdownDimensions` + # @return [Array] + attr_accessor :breakdown_dimensions + # The ID of the creative on which to filter; optional. This field may be set # only for a filter set that accesses account-level troubleshooting data, # i.e., one whose name matches the `bidders/*/accounts/*/filterSets/*` @@ -1674,6 +1681,7 @@ module Google # Update properties of this object def update!(**args) @absolute_date_range = args[:absolute_date_range] if args.key?(:absolute_date_range) + @breakdown_dimensions = args[:breakdown_dimensions] if args.key?(:breakdown_dimensions) @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) @@ -3703,6 +3711,13 @@ module Google class RowDimensions include Google::Apis::Core::Hashable + # The publisher identifier for this row, if a breakdown by + # BreakdownDimension.PUBLISHER_IDENTIFIER + # was requested. + # Corresponds to the JSON property `publisherIdentifier` + # @return [String] + attr_accessor :publisher_identifier + # An interval of time, with an absolute start and end. # Corresponds to the JSON property `timeInterval` # @return [Google::Apis::Adexchangebuyer2V2beta1::TimeInterval] @@ -3714,6 +3729,7 @@ module Google # Update properties of this object def update!(**args) + @publisher_identifier = args[:publisher_identifier] if args.key?(:publisher_identifier) @time_interval = args[:time_interval] if args.key?(:time_interval) end end diff --git a/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb b/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb index 000ae565c..dceb4f649 100644 --- a/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +++ b/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb @@ -1061,6 +1061,7 @@ 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 + collection :breakdown_dimensions, as: 'breakdownDimensions' property :creative_id, as: 'creativeId' property :deal_id, :numeric_string => true, as: 'dealId' property :environment, as: 'environment' @@ -1644,6 +1645,7 @@ module Google class RowDimensions # @private class Representation < Google::Apis::Core::JsonRepresentation + property :publisher_identifier, as: 'publisherIdentifier' property :time_interval, as: 'timeInterval', class: Google::Apis::Adexchangebuyer2V2beta1::TimeInterval, decorator: Google::Apis::Adexchangebuyer2V2beta1::TimeInterval::Representation end diff --git a/generated/google/apis/alertcenter_v1beta1.rb b/generated/google/apis/alertcenter_v1beta1.rb index 0e58ee16a..cc0ee6aac 100644 --- a/generated/google/apis/alertcenter_v1beta1.rb +++ b/generated/google/apis/alertcenter_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/admin-sdk/alertcenter/ module AlertcenterV1beta1 VERSION = 'V1beta1' - REVISION = '20181010' + REVISION = '20181018' end end end diff --git a/generated/google/apis/alertcenter_v1beta1/classes.rb b/generated/google/apis/alertcenter_v1beta1/classes.rb index ea77cf490..2c15728e9 100644 --- a/generated/google/apis/alertcenter_v1beta1/classes.rb +++ b/generated/google/apis/alertcenter_v1beta1/classes.rb @@ -73,6 +73,12 @@ module Google # @return [Hash] attr_accessor :data + # Output only. Whether this alert has been marked for deletion. + # Corresponds to the JSON property `deleted` + # @return [Boolean] + attr_accessor :deleted + alias_method :deleted?, :deleted + # Optional. The time this alert was no longer active. If provided, the # end time must not be earlier than the start time. If not provided, the end # time will default to the start time. @@ -139,6 +145,7 @@ module Google @create_time = args[:create_time] if args.key?(:create_time) @customer_id = args[:customer_id] if args.key?(:customer_id) @data = args[:data] if args.key?(:data) + @deleted = args[:deleted] if args.key?(:deleted) @end_time = args[:end_time] if args.key?(:end_time) @security_investigation_tool_link = args[:security_investigation_tool_link] if args.key?(:security_investigation_tool_link) @source = args[:source] if args.key?(:source) @@ -596,13 +603,13 @@ module Google class LoginDetails include Google::Apis::Core::Hashable - # Required. Human readable IP address (e.g., 11.22.33.44) that is + # Optional. Human readable IP address (e.g., 11.22.33.44) that is # associated with the warning event. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address - # Required. Login time that is associated with the warning event. + # Optional. Login time that is associated with the warning event. # Corresponds to the JSON property `loginTime` # @return [String] attr_accessor :login_time diff --git a/generated/google/apis/alertcenter_v1beta1/representations.rb b/generated/google/apis/alertcenter_v1beta1/representations.rb index d310fcb16..3cb338a01 100644 --- a/generated/google/apis/alertcenter_v1beta1/representations.rb +++ b/generated/google/apis/alertcenter_v1beta1/representations.rb @@ -176,6 +176,7 @@ module Google property :create_time, as: 'createTime' property :customer_id, as: 'customerId' hash :data, as: 'data' + property :deleted, as: 'deleted' property :end_time, as: 'endTime' property :security_investigation_tool_link, as: 'securityInvestigationToolLink' property :source, as: 'source' diff --git a/generated/google/apis/androiddeviceprovisioning_v1.rb b/generated/google/apis/androiddeviceprovisioning_v1.rb index 32e5d97e8..4c0644267 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 = '20181007' + REVISION = '20181027' end end end diff --git a/generated/google/apis/androiddeviceprovisioning_v1/service.rb b/generated/google/apis/androiddeviceprovisioning_v1/service.rb index 8e5b44647..1f14e2077 100644 --- a/generated/google/apis/androiddeviceprovisioning_v1/service.rb +++ b/generated/google/apis/androiddeviceprovisioning_v1/service.rb @@ -495,8 +495,9 @@ module Google # Creates a customer for zero-touch enrollment. After the method returns # successfully, admin and owner roles can manage devices and EMM configs - # by calling API methods or using their zero-touch enrollment portal. The API - # doesn't notify the customer that they have access. + # by calling API methods or using their zero-touch enrollment portal. + # The customer receives an email that welcomes them to zero-touch enrollment + # and explains how to sign into the portal. # @param [String] parent # Required. The parent resource ID in the format `partners/[PARTNER_ID]` that # identifies the reseller. diff --git a/generated/google/apis/androidenterprise_v1.rb b/generated/google/apis/androidenterprise_v1.rb index 2b9e73bb8..144ffd30d 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 = '20181001' + REVISION = '20181024' # 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 eda9249c6..e8c0081d4 100644 --- a/generated/google/apis/androidenterprise_v1/classes.rb +++ b/generated/google/apis/androidenterprise_v1/classes.rb @@ -91,7 +91,7 @@ module Google # @return [Array] attr_accessor :permission - # Options for displaying the Play Search page. + # Options for displaying the managed Play Search apps page. # Corresponds to the JSON property `playSearch` # @return [Google::Apis::AndroidenterpriseV1::AdministratorWebTokenSpecPlaySearch] attr_accessor :play_search @@ -101,7 +101,7 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::AdministratorWebTokenSpecPrivateApps] attr_accessor :private_apps - # Options for displaying the Store Builder page. + # Options for displaying the Organize apps page. # Corresponds to the JSON property `storeBuilder` # @return [Google::Apis::AndroidenterpriseV1::AdministratorWebTokenSpecStoreBuilder] attr_accessor :store_builder @@ -137,7 +137,7 @@ module Google attr_accessor :approve_apps alias_method :approve_apps?, :approve_apps - # Whether the Play Search page is displayed. Default is true. + # Whether the managed Play Search apps page is displayed. Default is true. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled @@ -178,7 +178,7 @@ module Google class AdministratorWebTokenSpecStoreBuilder include Google::Apis::Core::Hashable - # Whether the Store Builder page is displayed. Default is true. + # Whether the Organize apps page is displayed. Default is true. # Corresponds to the JSON property `enabled` # @return [Boolean] attr_accessor :enabled @@ -429,12 +429,24 @@ module Google class AppVersion include Google::Apis::Core::Hashable + # True if this version is a production Apk. + # Corresponds to the JSON property `isProduction` + # @return [Boolean] + attr_accessor :is_production + alias_method :is_production?, :is_production + # The track that this app was published in. For example if track is "alpha", - # this is an alpha version of the app. + # this is an alpha version of the app. Deprecated, use track_id instead. # Corresponds to the JSON property `track` # @return [String] attr_accessor :track + # The track ids that this version was published in. This field supersedes track, + # but doesn't include the production track. + # Corresponds to the JSON property `trackId` + # @return [Array] + attr_accessor :track_id + # Unique increasing identifier for the app version. # Corresponds to the JSON property `versionCode` # @return [Fixnum] @@ -453,7 +465,9 @@ module Google # Update properties of this object def update!(**args) + @is_production = args[:is_production] if args.key?(:is_production) @track = args[:track] if args.key?(:track) + @track_id = args[:track_id] if args.key?(:track_id) @version_code = args[:version_code] if args.key?(:version_code) @version_string = args[:version_string] if args.key?(:version_string) end @@ -1778,6 +1792,11 @@ module Google class Product include Google::Apis::Core::Hashable + # The tracks that are visible to the enterprise with their user-friendly name. + # Corresponds to the JSON property `appTracks` + # @return [Array] + attr_accessor :app_tracks + # App versions currently available for this product. # Corresponds to the JSON property `appVersion` # @return [Array] @@ -1793,7 +1812,8 @@ module Google # @return [Array] attr_accessor :available_countries - # The tracks that are visible to the enterprise. + # The tracks that are visible to the enterprise. Deprecated, use app_tracks + # instead. # Corresponds to the JSON property `availableTracks` # @return [Array] attr_accessor :available_tracks @@ -1913,6 +1933,7 @@ module Google # Update properties of this object def update!(**args) + @app_tracks = args[:app_tracks] if args.key?(:app_tracks) @app_version = args[:app_version] if args.key?(:app_version) @author_name = args[:author_name] if args.key?(:author_name) @available_countries = args[:available_countries] if args.key?(:available_countries) @@ -2063,6 +2084,12 @@ module Google # @return [String] attr_accessor :product_id + # Grants visibility to the specified track(s) of the product to the device. The + # existing track ids can be obtained by calling Products.Get. + # Corresponds to the JSON property `trackIds` + # @return [Array] + attr_accessor :track_ids + # Grants visibility to the specified track(s) of the product to the device. The # track available to the device is based on the following order of preference: # alpha, beta, production. For example, if an app has a prod version, a beta @@ -2077,6 +2104,7 @@ module Google # production"` `"beta", "production"` `"alpha", "beta", "production"` The order # of elements is not relevant. Any other set of tracks will be rejected with an # error. + # This is deprecated. Use track_ids instead. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -2088,6 +2116,7 @@ module Google # Update properties of this object def update!(**args) @product_id = args[:product_id] if args.key?(:product_id) + @track_ids = args[:track_ids] if args.key?(:track_ids) @tracks = args[:tracks] if args.key?(:tracks) end end @@ -2181,6 +2210,12 @@ module Google # @return [String] attr_accessor :product_id + # Grants visibility to the specified track(s) of the product to the user. This + # replaces the tracks field, and specifies the track by their unique id. + # Corresponds to the JSON property `trackIds` + # @return [Array] + attr_accessor :track_ids + # 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 @@ -2195,6 +2230,7 @@ module Google # production"` `"beta", "production"` `"alpha", "beta", "production"` The order # of elements is not relevant. Any other set of tracks will be rejected with an # error. + # This is deprecated. Use track_ids instead. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -2206,6 +2242,7 @@ module Google # Update properties of this object def update!(**args) @product_id = args[:product_id] if args.key?(:product_id) + @track_ids = args[:track_ids] if args.key?(:track_ids) @tracks = args[:tracks] if args.key?(:tracks) end end @@ -2654,6 +2691,31 @@ module Google end end + # Id to name association of a track. + class TrackInfo + include Google::Apis::Core::Hashable + + # A changeable, user-friendly name for a track. + # Corresponds to the JSON property `trackAlias` + # @return [String] + attr_accessor :track_alias + + # A unique an unchangeable identifier of a test track. + # Corresponds to the JSON property `trackId` + # @return [String] + attr_accessor :track_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @track_alias = args[:track_alias] if args.key?(:track_alias) + @track_id = args[:track_id] if args.key?(:track_id) + end + end + # A Users resource represents an account associated with an enterprise. The # account may be specific to a device or to an individual user (who can then use # the account across multiple devices). The account may provide access to diff --git a/generated/google/apis/androidenterprise_v1/representations.rb b/generated/google/apis/androidenterprise_v1/representations.rb index 485f8ae68..10949b682 100644 --- a/generated/google/apis/androidenterprise_v1/representations.rb +++ b/generated/google/apis/androidenterprise_v1/representations.rb @@ -442,6 +442,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class TrackInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class User class Representation < Google::Apis::Core::JsonRepresentation; end @@ -588,7 +594,9 @@ module Google class AppVersion # @private class Representation < Google::Apis::Core::JsonRepresentation + property :is_production, as: 'isProduction' property :track, as: 'track' + collection :track_id, as: 'trackId' property :version_code, as: 'versionCode' property :version_string, as: 'versionString' end @@ -940,6 +948,8 @@ module Google class Product # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :app_tracks, as: 'appTracks', class: Google::Apis::AndroidenterpriseV1::TrackInfo, decorator: Google::Apis::AndroidenterpriseV1::TrackInfo::Representation + collection :app_version, as: 'appVersion', class: Google::Apis::AndroidenterpriseV1::AppVersion, decorator: Google::Apis::AndroidenterpriseV1::AppVersion::Representation property :author_name, as: 'authorName' @@ -1007,6 +1017,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :product_id, as: 'productId' + collection :track_ids, as: 'trackIds' collection :tracks, as: 'tracks' end end @@ -1034,6 +1045,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :product_id, as: 'productId' + collection :track_ids, as: 'trackIds' collection :tracks, as: 'tracks' end end @@ -1163,6 +1175,14 @@ module Google end end + class TrackInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :track_alias, as: 'trackAlias' + property :track_id, as: 'trackId' + end + end + class User # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/androidmanagement_v1.rb b/generated/google/apis/androidmanagement_v1.rb index 7d80df0d1..3aeaf2663 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 = '20181008' + REVISION = '20181029' # 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 300859322..3ebf3f825 100644 --- a/generated/google/apis/androidmanagement_v1/classes.rb +++ b/generated/google/apis/androidmanagement_v1/classes.rb @@ -213,10 +213,8 @@ module Google # @return [Hash] attr_accessor :managed_configuration - # The formulated managed configuration with the managed configuration template - # applied to the app. To generate a web token that identifies the enterprise use - # https://developers.google.com/android/management/reference/rest/v1/enterprises. - # webTokens + # The managed configurations template for the app, saved from the managed + # configurations iframe. # Corresponds to the JSON property `managedConfigurationTemplate` # @return [Google::Apis::AndroidmanagementV1::ManagedConfigurationTemplate] attr_accessor :managed_configuration_template @@ -1279,10 +1277,8 @@ module Google end end - # The formulated managed configuration with the managed configuration template - # applied to the app. To generate a web token that identifies the enterprise use - # https://developers.google.com/android/management/reference/rest/v1/enterprises. - # webTokens + # The managed configurations template for the app, saved from the managed + # configurations iframe. class ManagedConfigurationTemplate include Google::Apis::Core::Hashable @@ -1763,6 +1759,11 @@ module Google # @return [String] attr_accessor :password_quality + # The scope that the password requirement applies to. + # Corresponds to the JSON property `passwordScope` + # @return [String] + attr_accessor :password_scope + def initialize(**args) update!(**args) end @@ -1780,6 +1781,7 @@ module Google @password_minimum_symbols = args[:password_minimum_symbols] if args.key?(:password_minimum_symbols) @password_minimum_upper_case = args[:password_minimum_upper_case] if args.key?(:password_minimum_upper_case) @password_quality = args[:password_quality] if args.key?(:password_quality) + @password_scope = args[:password_scope] if args.key?(:password_scope) end end @@ -2137,14 +2139,8 @@ module Google attr_accessor :outgoing_calls_disabled alias_method :outgoing_calls_disabled?, :outgoing_calls_disabled - # Password policy that can apply to different scope e.g. at either a device or - # profile level. 'password_requirements' is overridden if this policy is set - # with default scope or with scope explicitly applying to the scope that ' - # password_requirements' applies to. If scope is not specified then restriction - # applies to the default scope i.e. profile in a managed profile. If an entry - # exists with unspecified scope and also an entry for the default scope with - # scope explicitly specified then the explicit restriction overrides the default - # scope restriction. + # Password requirement policies. Different policies can be set for work profile + # or fully managed devices by setting the password_scope field in the policy. # Corresponds to the JSON property `passwordPolicies` # @return [Array] attr_accessor :password_policies diff --git a/generated/google/apis/androidmanagement_v1/representations.rb b/generated/google/apis/androidmanagement_v1/representations.rb index 14864f2b7..388911405 100644 --- a/generated/google/apis/androidmanagement_v1/representations.rb +++ b/generated/google/apis/androidmanagement_v1/representations.rb @@ -718,6 +718,7 @@ module Google property :password_minimum_symbols, as: 'passwordMinimumSymbols' property :password_minimum_upper_case, as: 'passwordMinimumUpperCase' property :password_quality, as: 'passwordQuality' + property :password_scope, as: 'passwordScope' end end diff --git a/generated/google/apis/appengine_v1.rb b/generated/google/apis/appengine_v1.rb index cf95da215..440e09d11 100644 --- a/generated/google/apis/appengine_v1.rb +++ b/generated/google/apis/appengine_v1.rb @@ -20,13 +20,12 @@ module Google module Apis # App Engine Admin API # - # The App Engine Admin API enables developers to provision and manage their App - # Engine applications. + # Provisions and manages developers' App Engine applications. # # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1 VERSION = 'V1' - REVISION = '20181017' + REVISION = '20181020' # 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/service.rb b/generated/google/apis/appengine_v1/service.rb index e1707b100..514dffea1 100644 --- a/generated/google/apis/appengine_v1/service.rb +++ b/generated/google/apis/appengine_v1/service.rb @@ -22,8 +22,7 @@ module Google module AppengineV1 # App Engine Admin API # - # The App Engine Admin API enables developers to provision and manage their App - # Engine applications. + # Provisions and manages developers' App Engine applications. # # @example # require 'google/apis/appengine_v1' diff --git a/generated/google/apis/appengine_v1alpha.rb b/generated/google/apis/appengine_v1alpha.rb index 1d8aac73a..6d3bb3a40 100644 --- a/generated/google/apis/appengine_v1alpha.rb +++ b/generated/google/apis/appengine_v1alpha.rb @@ -20,13 +20,12 @@ module Google module Apis # App Engine Admin API # - # The App Engine Admin API enables developers to provision and manage their App - # Engine applications. + # Provisions and manages developers' App Engine applications. # # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1alpha VERSION = 'V1alpha' - REVISION = '20181017' + REVISION = '20181020' # 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/service.rb b/generated/google/apis/appengine_v1alpha/service.rb index 06e2660df..0d342fef3 100644 --- a/generated/google/apis/appengine_v1alpha/service.rb +++ b/generated/google/apis/appengine_v1alpha/service.rb @@ -22,8 +22,7 @@ module Google module AppengineV1alpha # App Engine Admin API # - # The App Engine Admin API enables developers to provision and manage their App - # Engine applications. + # Provisions and manages developers' App Engine applications. # # @example # require 'google/apis/appengine_v1alpha' diff --git a/generated/google/apis/appengine_v1beta.rb b/generated/google/apis/appengine_v1beta.rb index d0ce7cc42..f227db765 100644 --- a/generated/google/apis/appengine_v1beta.rb +++ b/generated/google/apis/appengine_v1beta.rb @@ -20,13 +20,12 @@ module Google module Apis # App Engine Admin API # - # The App Engine Admin API enables developers to provision and manage their App - # Engine applications. + # Provisions and manages developers' App Engine applications. # # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta VERSION = 'V1beta' - REVISION = '20181017' + REVISION = '20181020' # 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/service.rb b/generated/google/apis/appengine_v1beta/service.rb index e9a61d205..ec4d2e9f0 100644 --- a/generated/google/apis/appengine_v1beta/service.rb +++ b/generated/google/apis/appengine_v1beta/service.rb @@ -22,8 +22,7 @@ module Google module AppengineV1beta # App Engine Admin API # - # The App Engine Admin API enables developers to provision and manage their App - # Engine applications. + # Provisions and manages developers' App Engine applications. # # @example # require 'google/apis/appengine_v1beta' diff --git a/generated/google/apis/appengine_v1beta4.rb b/generated/google/apis/appengine_v1beta4.rb index a80fd24e5..941e00f12 100644 --- a/generated/google/apis/appengine_v1beta4.rb +++ b/generated/google/apis/appengine_v1beta4.rb @@ -20,13 +20,12 @@ module Google module Apis # App Engine Admin API # - # The App Engine Admin API enables developers to provision and manage their App - # Engine applications. + # Provisions and manages developers' App Engine applications. # # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta4 VERSION = 'V1beta4' - REVISION = '20181017' + REVISION = '20181020' # 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/service.rb b/generated/google/apis/appengine_v1beta4/service.rb index 1f8d4a51a..f6f75c3c8 100644 --- a/generated/google/apis/appengine_v1beta4/service.rb +++ b/generated/google/apis/appengine_v1beta4/service.rb @@ -22,8 +22,7 @@ module Google module AppengineV1beta4 # App Engine Admin API # - # The App Engine Admin API enables developers to provision and manage their App - # Engine applications. + # Provisions and manages developers' App Engine applications. # # @example # require 'google/apis/appengine_v1beta4' diff --git a/generated/google/apis/appengine_v1beta5.rb b/generated/google/apis/appengine_v1beta5.rb index b236983d9..37c6ef31a 100644 --- a/generated/google/apis/appengine_v1beta5.rb +++ b/generated/google/apis/appengine_v1beta5.rb @@ -20,13 +20,12 @@ module Google module Apis # App Engine Admin API # - # The App Engine Admin API enables developers to provision and manage their App - # Engine applications. + # Provisions and manages developers' App Engine applications. # # @see https://cloud.google.com/appengine/docs/admin-api/ module AppengineV1beta5 VERSION = 'V1beta5' - REVISION = '20181017' + REVISION = '20181020' # 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/service.rb b/generated/google/apis/appengine_v1beta5/service.rb index 7afc2cef3..691d6d6f5 100644 --- a/generated/google/apis/appengine_v1beta5/service.rb +++ b/generated/google/apis/appengine_v1beta5/service.rb @@ -22,8 +22,7 @@ module Google module AppengineV1beta5 # App Engine Admin API # - # The App Engine Admin API enables developers to provision and manage their App - # Engine applications. + # Provisions and manages developers' App Engine applications. # # @example # require 'google/apis/appengine_v1beta5' diff --git a/generated/google/apis/bigquery_v2.rb b/generated/google/apis/bigquery_v2.rb index 3052dc908..0b9de3ef9 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 = '20181005' + REVISION = '20181025' # 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 b50952ad0..10d287e2e 100644 --- a/generated/google/apis/bigquery_v2/classes.rb +++ b/generated/google/apis/bigquery_v2/classes.rb @@ -2089,9 +2089,8 @@ module Google # @return [String] attr_accessor :job_id - # The geographic location of the job. Required except for US and EU. See details - # at https://cloud.google.com/bigquery/docs/dataset-locations# - # specifying_your_location. + # The geographic location of the job. See details at https://cloud.google.com/ + # bigquery/docs/locations#specifying_your_location. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location @@ -3018,6 +3017,64 @@ module Google end end + # + class RangePartitioning + include Google::Apis::Core::Hashable + + # [Experimental] [Required] The table is partitioned by this field. The field + # must be a top-level NULLABLE/REQUIRED field. The only supported type is + # INTEGER/INT64. + # Corresponds to the JSON property `field` + # @return [String] + attr_accessor :field + + # [Experimental] [Required] Defines the ranges for range partitioning. + # Corresponds to the JSON property `range` + # @return [Google::Apis::BigqueryV2::RangePartitioning::Range] + attr_accessor :range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @field = args[:field] if args.key?(:field) + @range = args[:range] if args.key?(:range) + end + + # [Experimental] [Required] Defines the ranges for range partitioning. + class Range + include Google::Apis::Core::Hashable + + # [Experimental] [Required] The end of range partitioning, exclusive. + # Corresponds to the JSON property `end` + # @return [Fixnum] + attr_accessor :end + + # [Experimental] [Required] The width of each interval. + # Corresponds to the JSON property `interval` + # @return [Fixnum] + attr_accessor :interval + + # [Experimental] [Required] The start of range partitioning, inclusive. + # Corresponds to the JSON property `start` + # @return [Fixnum] + attr_accessor :start + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end = args[:end] if args.key?(:end) + @interval = args[:interval] if args.key?(:interval) + @start = args[:start] if args.key?(:start) + end + end + end + # class Streamingbuffer include Google::Apis::Core::Hashable @@ -3056,9 +3113,9 @@ module Google class Table include Google::Apis::Core::Hashable - # [Beta] Clustering specification for the table. Must be specified with time- - # based partitioning, data in the table will be first partitioned and - # subsequently clustered. + # [Experimental] Clustering specification for the table. Must be specified with + # partitioning, data in the table will be first partitioned and subsequently + # clustered. # Corresponds to the JSON property `clustering` # @return [Google::Apis::BigqueryV2::Clustering] attr_accessor :clustering @@ -3158,12 +3215,32 @@ module Google # @return [Fixnum] attr_accessor :num_long_term_bytes + # [Output-only] [Experimental] The physical size of this table in bytes, + # excluding any data in the streaming buffer. This includes compression and + # storage used for time travel. + # Corresponds to the JSON property `numPhysicalBytes` + # @return [Fixnum] + attr_accessor :num_physical_bytes + # [Output-only] The number of rows of data in this table, excluding any data in # the streaming buffer. # Corresponds to the JSON property `numRows` # @return [Fixnum] attr_accessor :num_rows + # [Experimental] Range partitioning specification for this table. Only one of + # timePartitioning and rangePartitioning should be specified. + # Corresponds to the JSON property `rangePartitioning` + # @return [Google::Apis::BigqueryV2::RangePartitioning] + attr_accessor :range_partitioning + + # [Experimental] [Optional] If set to true, queries over this table require a + # partition filter that can be used for partition elimination to be specified. + # Corresponds to the JSON property `requirePartitionFilter` + # @return [Boolean] + attr_accessor :require_partition_filter + alias_method :require_partition_filter?, :require_partition_filter + # [Optional] Describes the schema of this table. # Corresponds to the JSON property `schema` # @return [Google::Apis::BigqueryV2::TableSchema] @@ -3186,7 +3263,8 @@ module Google # @return [Google::Apis::BigqueryV2::TableReference] attr_accessor :table_reference - # Time-based partitioning specification for this table. + # Time-based partitioning specification for this table. Only one of + # timePartitioning and rangePartitioning should be specified. # Corresponds to the JSON property `timePartitioning` # @return [Google::Apis::BigqueryV2::TimePartitioning] attr_accessor :time_partitioning @@ -3226,7 +3304,10 @@ module Google @model = args[:model] if args.key?(:model) @num_bytes = args[:num_bytes] if args.key?(:num_bytes) @num_long_term_bytes = args[:num_long_term_bytes] if args.key?(:num_long_term_bytes) + @num_physical_bytes = args[:num_physical_bytes] if args.key?(:num_physical_bytes) @num_rows = args[:num_rows] if args.key?(:num_rows) + @range_partitioning = args[:range_partitioning] if args.key?(:range_partitioning) + @require_partition_filter = args[:require_partition_filter] if args.key?(:require_partition_filter) @schema = args[:schema] if args.key?(:schema) @self_link = args[:self_link] if args.key?(:self_link) @streaming_buffer = args[:streaming_buffer] if args.key?(:streaming_buffer) diff --git a/generated/google/apis/bigquery_v2/representations.rb b/generated/google/apis/bigquery_v2/representations.rb index f94e7ce44..b3b888fb8 100644 --- a/generated/google/apis/bigquery_v2/representations.rb +++ b/generated/google/apis/bigquery_v2/representations.rb @@ -316,6 +316,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class RangePartitioning + class Representation < Google::Apis::Core::JsonRepresentation; end + + class Range + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + include Google::Apis::Core::JsonObjectSupport + end + class Streamingbuffer class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1124,6 +1136,24 @@ module Google end end + class RangePartitioning + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :field, as: 'field' + property :range, as: 'range', class: Google::Apis::BigqueryV2::RangePartitioning::Range, decorator: Google::Apis::BigqueryV2::RangePartitioning::Range::Representation + + end + + class Range + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end, :numeric_string => true, as: 'end' + property :interval, :numeric_string => true, as: 'interval' + property :start, :numeric_string => true, as: 'start' + end + end + end + class Streamingbuffer # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1156,7 +1186,11 @@ module Google property :num_bytes, :numeric_string => true, as: 'numBytes' property :num_long_term_bytes, :numeric_string => true, as: 'numLongTermBytes' + property :num_physical_bytes, :numeric_string => true, as: 'numPhysicalBytes' property :num_rows, :numeric_string => true, as: 'numRows' + property :range_partitioning, as: 'rangePartitioning', class: Google::Apis::BigqueryV2::RangePartitioning, decorator: Google::Apis::BigqueryV2::RangePartitioning::Representation + + property :require_partition_filter, as: 'requirePartitionFilter' property :schema, as: 'schema', class: Google::Apis::BigqueryV2::TableSchema, decorator: Google::Apis::BigqueryV2::TableSchema::Representation property :self_link, as: 'selfLink' diff --git a/generated/google/apis/bigquerydatatransfer_v1.rb b/generated/google/apis/bigquerydatatransfer_v1.rb index 877783078..5d058b857 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 = '20181001' + REVISION = '20181027' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/civicinfo_v2.rb b/generated/google/apis/civicinfo_v2.rb index 756f13777..cba57423e 100644 --- a/generated/google/apis/civicinfo_v2.rb +++ b/generated/google/apis/civicinfo_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/civic-information module CivicinfoV2 VERSION = 'V2' - REVISION = '20180716' + REVISION = '20181017' end end end diff --git a/generated/google/apis/civicinfo_v2/classes.rb b/generated/google/apis/civicinfo_v2/classes.rb index 9d2d1c650..883e7aef8 100644 --- a/generated/google/apis/civicinfo_v2/classes.rb +++ b/generated/google/apis/civicinfo_v2/classes.rb @@ -1176,6 +1176,22 @@ module Google # @return [String] attr_accessor :id + # Latitude of the location, in degrees north of the equator. Only some locations + # -- generally, ballot drop boxes for vote-by-mail elections -- will have this + # set; for others, use a geocoding service like the Google Maps API to resolve + # the address to a geographic point. + # Corresponds to the JSON property `latitude` + # @return [Float] + attr_accessor :latitude + + # Longitude of the location, in degrees east of the Prime Meridian. Only some + # locations -- generally, ballot drop boxes for vote-by-mail elections -- will + # have this set; for others, use a geocoding service like the Google Maps API to + # resolve the address to a geographic point. + # Corresponds to the JSON property `longitude` + # @return [Float] + attr_accessor :longitude + # The name of the early vote site or drop off location. This field is not # populated for polling locations. # Corresponds to the JSON property `name` @@ -1219,6 +1235,8 @@ module Google @address = args[:address] if args.key?(:address) @end_date = args[:end_date] if args.key?(:end_date) @id = args[:id] if args.key?(:id) + @latitude = args[:latitude] if args.key?(:latitude) + @longitude = args[:longitude] if args.key?(:longitude) @name = args[:name] if args.key?(:name) @notes = args[:notes] if args.key?(:notes) @polling_hours = args[:polling_hours] if args.key?(:polling_hours) diff --git a/generated/google/apis/civicinfo_v2/representations.rb b/generated/google/apis/civicinfo_v2/representations.rb index 7058cb70b..75f0aebdd 100644 --- a/generated/google/apis/civicinfo_v2/representations.rb +++ b/generated/google/apis/civicinfo_v2/representations.rb @@ -553,6 +553,8 @@ module Google property :end_date, as: 'endDate' property :id, as: 'id' + property :latitude, as: 'latitude' + property :longitude, as: 'longitude' property :name, as: 'name' property :notes, as: 'notes' property :polling_hours, as: 'pollingHours' diff --git a/generated/google/apis/cloudfunctions_v1.rb b/generated/google/apis/cloudfunctions_v1.rb index 29fd988d9..9c041b781 100644 --- a/generated/google/apis/cloudfunctions_v1.rb +++ b/generated/google/apis/cloudfunctions_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/functions module CloudfunctionsV1 VERSION = 'V1' - REVISION = '20180702' + REVISION = '20181018' # 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 63d0ab550..7872c473d 100644 --- a/generated/google/apis/cloudfunctions_v1/classes.rb +++ b/generated/google/apis/cloudfunctions_v1/classes.rb @@ -22,6 +22,170 @@ module Google module Apis module CloudfunctionsV1 + # 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. + # If there are AuditConfigs for both `allServices` and a specific service, + # the union of the two AuditConfigs is used for that service: the log_types + # specified in each AuditConfig are enabled, and the exempted_members in each + # AuditLogConfig are exempted. + # Example Policy with multiple AuditConfigs: + # ` + # "audit_configs": [ + # ` + # "service": "allServices" + # "audit_log_configs": [ + # ` + # "log_type": "DATA_READ", + # "exempted_members": [ + # "user:foo@gmail.com" + # ] + # `, + # ` + # "log_type": "DATA_WRITE", + # `, + # ` + # "log_type": "ADMIN_READ", + # ` + # ] + # `, + # ` + # "service": "fooservice.googleapis.com" + # "audit_log_configs": [ + # ` + # "log_type": "DATA_READ", + # `, + # ` + # "log_type": "DATA_WRITE", + # "exempted_members": [ + # "user:bar@gmail.com" + # ] + # ` + # ] + # ` + # ] + # ` + # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ + # logging. It also exempts foo@gmail.com from DATA_READ logging, and + # bar@gmail.com from DATA_WRITE logging. + class AuditConfig + include Google::Apis::Core::Hashable + + # The configuration for logging of each type of permission. + # Corresponds to the JSON property `auditLogConfigs` + # @return [Array] + attr_accessor :audit_log_configs + + # Specifies a service that will be enabled for audit logging. + # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. + # `allServices` is a special value that covers all services. + # 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) + @audit_log_configs = args[:audit_log_configs] if args.key?(:audit_log_configs) + @service = args[:service] if args.key?(:service) + end + end + + # Provides the configuration for logging a type of permissions. + # Example: + # ` + # "audit_log_configs": [ + # ` + # "log_type": "DATA_READ", + # "exempted_members": [ + # "user:foo@gmail.com" + # ] + # `, + # ` + # "log_type": "DATA_WRITE", + # ` + # ] + # ` + # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting + # foo@gmail.com from DATA_READ logging. + class AuditLogConfig + include Google::Apis::Core::Hashable + + # Specifies the identities that do not cause logging for this type of + # permission. + # Follows the same format of Binding.members. + # Corresponds to the JSON property `exemptedMembers` + # @return [Array] + attr_accessor :exempted_members + + # The log type that this config enables. + # Corresponds to the JSON property `logType` + # @return [String] + attr_accessor :log_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @exempted_members = args[:exempted_members] if args.key?(:exempted_members) + @log_type = args[:log_type] if args.key?(:log_type) + end + end + + # Associates `members` with a `role`. + class Binding + include Google::Apis::Core::Hashable + + # 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 `condition` + # @return [Google::Apis::CloudfunctionsV1::Expr] + attr_accessor :condition + + # Specifies the identities requesting access for a Cloud Platform resource. + # `members` can have the following values: + # * `allUsers`: A special identifier that represents anyone who is + # on the internet; with or without a Google account. + # * `allAuthenticatedUsers`: A special identifier that represents anyone + # who is authenticated with a Google account or a service account. + # * `user:`emailid``: An email address that represents a specific Google + # account. For example, `alice@gmail.com` . + # * `serviceAccount:`emailid``: An email address that represents a service + # account. For example, `my-other-app@appspot.gserviceaccount.com`. + # * `group:`emailid``: An email address that represents a Google group. + # For example, `admins@example.com`. + # * `domain:`domain``: A Google Apps domain name that represents all the + # users of that domain. For example, `google.com` or `example.com`. + # Corresponds to the JSON property `members` + # @return [Array] + attr_accessor :members + + # Role that is assigned to `members`. + # 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) + @condition = args[:condition] if args.key?(:condition) + @members = args[:members] if args.key?(:members) + @role = args[:role] if args.key?(:role) + end + end + # Request for the `CallFunction` method. class CallFunctionRequest include Google::Apis::Core::Hashable @@ -76,6 +240,7 @@ module Google # Describes a Cloud Function that contains user computation executed in # response to an event. It encapsulate function and triggers configurations. + # LINT.IfChange class CloudFunction include Google::Apis::Core::Hashable @@ -143,6 +308,8 @@ module Google # `projects/`project`/global/networks/`network`` or ``network``, where # `project` is a project id where the network is defined, and `network` is # the short name of the network. + # This field is mutually exclusive with `vpc_connector` and will be replaced + # by it. # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for # more information on connecting Cloud projects. # This feature is currently in alpha, available only for whitelisted users. @@ -203,6 +370,19 @@ module Google # @return [Fixnum] attr_accessor :version_id + # The VPC Network Connector that this cloud function can connect to. It can + # be either the fully-qualified URI, or the short name of the network + # connector resource. The format of this field is + # `projects/*/locations/*/connectors/*` + # This field is mutually exclusive with `network` field and will eventually + # replace it. + # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for + # more information on connecting Cloud projects. + # This feature is currently in alpha, available only for whitelisted users. + # Corresponds to the JSON property `vpcConnector` + # @return [String] + attr_accessor :vpc_connector + def initialize(**args) update!(**args) end @@ -228,6 +408,7 @@ module Google @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) + @vpc_connector = args[:vpc_connector] if args.key?(:vpc_connector) end end @@ -298,6 +479,53 @@ module Google 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" + class Expr + include Google::Apis::Core::Hashable + + # An optional description of the expression. This is a longer text which + # describes the expression, e.g. when hovered over it in a UI. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Textual representation of an expression in + # Common Expression Language syntax. + # The application context of the containing message determines which + # well-known feature set of CEL is supported. + # Corresponds to the JSON property `expression` + # @return [String] + attr_accessor :expression + + # An optional string indicating the location of the expression for error + # reporting, e.g. a file name and a position in the file. + # Corresponds to the JSON property `location` + # @return [String] + attr_accessor :location + + # An optional title for the expression, i.e. a short string describing + # its purpose. This can be used e.g. in UIs which allow to enter the + # expression. + # 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) + @expression = args[:expression] if args.key?(:expression) + @location = args[:location] if args.key?(:location) + @title = args[:title] if args.key?(:title) + 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 @@ -727,6 +955,89 @@ module Google end end + # Defines an Identity and Access Management (IAM) policy. It is used to + # specify access control policies for Cloud Platform resources. + # A `Policy` consists of a list of `bindings`. A `binding` binds a list of + # `members` to a `role`, where the members can be user accounts, Google groups, + # Google domains, and service accounts. A `role` is a named list of permissions + # defined by IAM. + # **JSON Example** + # ` + # "bindings": [ + # ` + # "role": "roles/owner", + # "members": [ + # "user:mike@example.com", + # "group:admins@example.com", + # "domain:google.com", + # "serviceAccount:my-other-app@appspot.gserviceaccount.com" + # ] + # `, + # ` + # "role": "roles/viewer", + # "members": ["user:sean@example.com"] + # ` + # ] + # ` + # **YAML Example** + # bindings: + # - members: + # - user:mike@example.com + # - group:admins@example.com + # - domain:google.com + # - serviceAccount:my-other-app@appspot.gserviceaccount.com + # role: roles/owner + # - members: + # - user:sean@example.com + # role: roles/viewer + # For a description of IAM and its features, see the + # [IAM developer's guide](https://cloud.google.com/iam/docs). + class Policy + include Google::Apis::Core::Hashable + + # Specifies cloud audit logging configuration for this policy. + # Corresponds to the JSON property `auditConfigs` + # @return [Array] + attr_accessor :audit_configs + + # Associates a list of `members` to a `role`. + # `bindings` with no members will result in an error. + # Corresponds to the JSON property `bindings` + # @return [Array] + attr_accessor :bindings + + # `etag` is used for optimistic concurrency control as a way to help + # prevent simultaneous updates of a policy from overwriting each other. + # It is strongly suggested that systems make use of the `etag` in the + # read-modify-write cycle to perform policy updates in order to avoid race + # conditions: An `etag` is returned in the response to `getIamPolicy`, and + # systems are expected to put that etag in the request to `setIamPolicy` to + # ensure that their change will be applied to the same version of the policy. + # If no `etag` is provided in the call to `setIamPolicy`, then the existing + # policy is overwritten blindly. + # Corresponds to the JSON property `etag` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :etag + + # Deprecated. + # Corresponds to the JSON property `version` + # @return [Fixnum] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audit_configs = args[:audit_configs] if args.key?(:audit_configs) + @bindings = args[:bindings] if args.key?(:bindings) + @etag = args[:etag] if args.key?(:etag) + @version = args[:version] if args.key?(:version) + 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 @@ -744,6 +1055,71 @@ module Google end end + # Request message for `SetIamPolicy` method. + class SetIamPolicyRequest + include Google::Apis::Core::Hashable + + # Defines an Identity and Access Management (IAM) policy. It is used to + # specify access control policies for Cloud Platform resources. + # A `Policy` consists of a list of `bindings`. A `binding` binds a list of + # `members` to a `role`, where the members can be user accounts, Google groups, + # Google domains, and service accounts. A `role` is a named list of permissions + # defined by IAM. + # **JSON Example** + # ` + # "bindings": [ + # ` + # "role": "roles/owner", + # "members": [ + # "user:mike@example.com", + # "group:admins@example.com", + # "domain:google.com", + # "serviceAccount:my-other-app@appspot.gserviceaccount.com" + # ] + # `, + # ` + # "role": "roles/viewer", + # "members": ["user:sean@example.com"] + # ` + # ] + # ` + # **YAML Example** + # bindings: + # - members: + # - user:mike@example.com + # - group:admins@example.com + # - domain:google.com + # - serviceAccount:my-other-app@appspot.gserviceaccount.com + # role: roles/owner + # - members: + # - user:sean@example.com + # role: roles/viewer + # For a description of IAM and its features, see the + # [IAM developer's guide](https://cloud.google.com/iam/docs). + # Corresponds to the JSON property `policy` + # @return [Google::Apis::CloudfunctionsV1::Policy] + attr_accessor :policy + + # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only + # the fields in the mask will be modified. If no mask is provided, the + # following default mask is used: + # paths: "bindings, etag" + # This field is only used by Cloud IAM. + # 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) + @policy = args[:policy] if args.key?(:policy) + @update_mask = args[:update_mask] if args.key?(:update_mask) + end + end + # Describes SourceRepository, used to represent parameters related to # source repository where a function is hosted. class SourceRepository @@ -855,6 +1231,48 @@ module Google @message = args[:message] if args.key?(:message) end end + + # Request message for `TestIamPermissions` method. + class TestIamPermissionsRequest + include Google::Apis::Core::Hashable + + # The set of permissions to check for the `resource`. Permissions with + # wildcards (such as '*' or 'storage.*') are not allowed. For more + # information see + # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @permissions = args[:permissions] if args.key?(:permissions) + end + end + + # Response message for `TestIamPermissions` method. + class TestIamPermissionsResponse + include Google::Apis::Core::Hashable + + # A subset of `TestPermissionsRequest.permissions` that the caller is + # allowed. + # Corresponds to the JSON property `permissions` + # @return [Array] + attr_accessor :permissions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @permissions = args[:permissions] if args.key?(:permissions) + end + end end end end diff --git a/generated/google/apis/cloudfunctions_v1/representations.rb b/generated/google/apis/cloudfunctions_v1/representations.rb index f6b8d49b2..0d95895b0 100644 --- a/generated/google/apis/cloudfunctions_v1/representations.rb +++ b/generated/google/apis/cloudfunctions_v1/representations.rb @@ -22,6 +22,24 @@ module Google module Apis module CloudfunctionsV1 + class AuditConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditLogConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Binding + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CallFunctionRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -46,6 +64,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Expr + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class FailurePolicy class Representation < Google::Apis::Core::JsonRepresentation; end @@ -124,12 +148,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Policy + 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 SetIamPolicyRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SourceRepository class Representation < Google::Apis::Core::JsonRepresentation; end @@ -142,6 +178,45 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class TestIamPermissionsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TestIamPermissionsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AuditConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::CloudfunctionsV1::AuditLogConfig, decorator: Google::Apis::CloudfunctionsV1::AuditLogConfig::Representation + + property :service, as: 'service' + end + end + + class AuditLogConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :exempted_members, as: 'exemptedMembers' + property :log_type, as: 'logType' + end + end + + class Binding + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :condition, as: 'condition', class: Google::Apis::CloudfunctionsV1::Expr, decorator: Google::Apis::CloudfunctionsV1::Expr::Representation + + collection :members, as: 'members' + property :role, as: 'role' + end + end + class CallFunctionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -183,6 +258,7 @@ module Google property :timeout, as: 'timeout' property :update_time, as: 'updateTime' property :version_id, :numeric_string => true, as: 'versionId' + property :vpc_connector, as: 'vpcConnector' end end @@ -197,6 +273,16 @@ module Google end end + class Expr + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :expression, as: 'expression' + property :location, as: 'location' + property :title, as: 'title' + end + end + class FailurePolicy # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -311,12 +397,33 @@ module Google end end + class Policy + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audit_configs, as: 'auditConfigs', class: Google::Apis::CloudfunctionsV1::AuditConfig, decorator: Google::Apis::CloudfunctionsV1::AuditConfig::Representation + + collection :bindings, as: 'bindings', class: Google::Apis::CloudfunctionsV1::Binding, decorator: Google::Apis::CloudfunctionsV1::Binding::Representation + + property :etag, :base64 => true, as: 'etag' + property :version, as: 'version' + end + end + class Retry # @private class Representation < Google::Apis::Core::JsonRepresentation end end + class SetIamPolicyRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :policy, as: 'policy', class: Google::Apis::CloudfunctionsV1::Policy, decorator: Google::Apis::CloudfunctionsV1::Policy::Representation + + property :update_mask, as: 'updateMask' + end + end + class SourceRepository # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -333,6 +440,20 @@ module Google property :message, as: 'message' end end + + class TestIamPermissionsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end + + class TestIamPermissionsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :permissions, as: 'permissions' + end + end end end end diff --git a/generated/google/apis/cloudfunctions_v1/service.rb b/generated/google/apis/cloudfunctions_v1/service.rb index 4c2215c77..59dd528b6 100644 --- a/generated/google/apis/cloudfunctions_v1/service.rb +++ b/generated/google/apis/cloudfunctions_v1/service.rb @@ -381,6 +381,39 @@ module Google execute_or_queue_command(command, &block) end + # Gets the access control policy for a resource. + # Returns an empty policy if the resource exists and does not have a policy + # set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. + # See the operation documentation for the appropriate value for this 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudfunctionsV1::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudfunctionsV1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::CloudfunctionsV1::Policy::Representation + command.response_class = Google::Apis::CloudfunctionsV1::Policy + command.params['resource'] = resource unless resource.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, @@ -459,6 +492,80 @@ module Google 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 + # REQUIRED: The resource for which the policy is being specified. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::CloudfunctionsV1::SetIamPolicyRequest] set_iam_policy_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::Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudfunctionsV1::Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_function_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::CloudfunctionsV1::SetIamPolicyRequest::Representation + command.request_object = set_iam_policy_request_object + command.response_representation = Google::Apis::CloudfunctionsV1::Policy::Representation + command.response_class = Google::Apis::CloudfunctionsV1::Policy + command.params['resource'] = resource unless resource.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 permissions that a caller has on the specified resource. + # If the resource does not exist, this will return an empty set of + # permissions, not a NOT_FOUND error. + # Note: This operation is designed to be used for building permission-aware + # UIs and command-line tools, not for authorization checking. This operation + # may "fail open" without warning. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. + # See the operation documentation for the appropriate value for this field. + # @param [Google::Apis::CloudfunctionsV1::TestIamPermissionsRequest] test_iam_permissions_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::TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudfunctionsV1::TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_function_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options) + command.request_representation = Google::Apis::CloudfunctionsV1::TestIamPermissionsRequest::Representation + command.request_object = test_iam_permissions_request_object + command.response_representation = Google::Apis::CloudfunctionsV1::TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::CloudfunctionsV1::TestIamPermissionsResponse + command.params['resource'] = resource unless resource.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/cloudsearch_v1.rb b/generated/google/apis/cloudsearch_v1.rb new file mode 100644 index 000000000..eec9b3aab --- /dev/null +++ b/generated/google/apis/cloudsearch_v1.rb @@ -0,0 +1,59 @@ +# 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/cloudsearch_v1/service.rb' +require 'google/apis/cloudsearch_v1/classes.rb' +require 'google/apis/cloudsearch_v1/representations.rb' + +module Google + module Apis + # Cloud Search API + # + # Cloud Search provides cloud-based search capabilities over G Suite data. The + # Cloud Search API allows indexing of non-G Suite data into Cloud Search. + # + # @see https://gsuite.google.com/products/cloud-search/ + module CloudsearchV1 + VERSION = 'V1' + REVISION = '20181029' + + # Index and serve your organization's data with Cloud Search + AUTH_CLOUD_SEARCH = 'https://www.googleapis.com/auth/cloud_search' + + # New Service: https://www.googleapis.com/auth/cloud_search.debug + AUTH_CLOUD_SEARCH_DEBUG = 'https://www.googleapis.com/auth/cloud_search.debug' + + # New Service: https://www.googleapis.com/auth/cloud_search.indexing + AUTH_CLOUD_SEARCH_INDEXING = 'https://www.googleapis.com/auth/cloud_search.indexing' + + # Search your organization's data in the Cloud Search index + AUTH_CLOUD_SEARCH_QUERY = 'https://www.googleapis.com/auth/cloud_search.query' + + # New Service: https://www.googleapis.com/auth/cloud_search.settings + AUTH_CLOUD_SEARCH_SETTINGS = 'https://www.googleapis.com/auth/cloud_search.settings' + + # New Service: https://www.googleapis.com/auth/cloud_search.settings.indexing + AUTH_CLOUD_SEARCH_SETTINGS_INDEXING = 'https://www.googleapis.com/auth/cloud_search.settings.indexing' + + # New Service: https://www.googleapis.com/auth/cloud_search.settings.query + AUTH_CLOUD_SEARCH_SETTINGS_QUERY = 'https://www.googleapis.com/auth/cloud_search.settings.query' + + # New Service: https://www.googleapis.com/auth/cloud_search.stats + AUTH_CLOUD_SEARCH_STATS = 'https://www.googleapis.com/auth/cloud_search.stats' + + # New Service: https://www.googleapis.com/auth/cloud_search.stats.indexing + AUTH_CLOUD_SEARCH_STATS_INDEXING = 'https://www.googleapis.com/auth/cloud_search.stats.indexing' + end + end +end diff --git a/generated/google/apis/cloudsearch_v1/classes.rb b/generated/google/apis/cloudsearch_v1/classes.rb new file mode 100644 index 000000000..7857f348e --- /dev/null +++ b/generated/google/apis/cloudsearch_v1/classes.rb @@ -0,0 +1,4697 @@ +# 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 CloudsearchV1 + + # Used to provide a search operator for boolean properties. This is + # optional. Search operators let users restrict the query to specific fields + # relevant to the type of item being searched. + class BooleanOperatorOptions + include Google::Apis::Core::Hashable + + # Indicates the operator name required in the query in order to isolate the + # boolean property. For example, if operatorName is *closed* and the + # property's name is *isClosed*, then queries like + # *closed:<value>* will show results only where the value of the + # property named *isClosed* matches *<value>*. By contrast, a + # search that uses the same *<value>* without an operator will return + # all items where *<value>* matches the value of any + # String properties or text within the content field for the item. + # The operator name can only contain lowercase letters (a-z). + # The maximum length is 32 characters. + # Corresponds to the JSON property `operatorName` + # @return [String] + attr_accessor :operator_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operator_name = args[:operator_name] if args.key?(:operator_name) + end + end + + # Options for boolean properties. + class BooleanPropertyOptions + include Google::Apis::Core::Hashable + + # Used to provide a search operator for boolean properties. This is + # optional. Search operators let users restrict the query to specific fields + # relevant to the type of item being searched. + # Corresponds to the JSON property `operatorOptions` + # @return [Google::Apis::CloudsearchV1::BooleanOperatorOptions] + attr_accessor :operator_options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operator_options = args[:operator_options] if args.key?(:operator_options) + end + end + + # + class CompositeFilter + include Google::Apis::Core::Hashable + + # The logic operator of the sub filter. + # Corresponds to the JSON property `logicOperator` + # @return [String] + attr_accessor :logic_operator + + # Sub filters. + # Corresponds to the JSON property `subFilters` + # @return [Array] + attr_accessor :sub_filters + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @logic_operator = args[:logic_operator] if args.key?(:logic_operator) + @sub_filters = args[:sub_filters] if args.key?(:sub_filters) + end + end + + # Aggregation of items by status code as of the specified date. + class CustomerIndexStats + include Google::Apis::Core::Hashable + + # Represents a whole calendar date, for example a date of birth. The time of day + # and time zone are either specified elsewhere or are not significant. The date + # is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/ + # wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date + # between the year 1 and 9999. + # Corresponds to the JSON property `date` + # @return [Google::Apis::CloudsearchV1::Date] + attr_accessor :date + + # Number of items aggregrated by status code. + # Corresponds to the JSON property `itemCountByStatus` + # @return [Array] + attr_accessor :item_count_by_status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @date = args[:date] if args.key?(:date) + @item_count_by_status = args[:item_count_by_status] if args.key?(:item_count_by_status) + end + end + + # Data source is a logical namespace for items to be indexed. + # All items must belong to a data source. This is the prerequisite before + # items can be indexed into Cloud Search. + class DataSource + include Google::Apis::Core::Hashable + + # If true, Indexing API rejects any modification calls to this data source + # such as create, update, and delete. + # Disabling this does not imply halting process of previously + # accepted data. + # Corresponds to the JSON property `disableModifications` + # @return [Boolean] + attr_accessor :disable_modifications + alias_method :disable_modifications?, :disable_modifications + + # Disable serving any search or assist results. + # Corresponds to the JSON property `disableServing` + # @return [Boolean] + attr_accessor :disable_serving + alias_method :disable_serving?, :disable_serving + + # Required. Display name of the data source + # The maximum length is 300 characters. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # List of service accounts that have indexing access. + # Corresponds to the JSON property `indexingServiceAccounts` + # @return [Array] + attr_accessor :indexing_service_accounts + + # This restricts visibility to items at a data source level to the + # disjunction of users/groups mentioned with the field. Note that, this + # does not ensure access to a specific item, as users need to have ACL + # permissions on the contained items. This ensures a high level access + # on the entire data source, and that the individual items are not shared + # outside this visibility. + # Corresponds to the JSON property `itemsVisibility` + # @return [Array] + attr_accessor :items_visibility + + # Name of the data source resource. + # Format: datasources/`source_id`. + #
The name is ignored when creating a data source. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # IDs of the Long Running Operations (LROs) currently running for this schema. + # Corresponds to the JSON property `operationIds` + # @return [Array] + attr_accessor :operation_ids + + # A short name or alias for the source. This value will be used to match the + # 'source' operator. For example, if the short name is *<value>* then + # queries like *source:<value>* will only return results for this + # source. The value must be unique across all data sources. The value must + # only contain alphanumeric characters (a-zA-Z0-9). The value cannot start + # with 'google' and cannot be one of the following: mail, gmail, docs, drive, + # groups, sites, calendar, hangouts, gplus, keep. + # Its maximum length is 32 characters. + # Corresponds to the JSON property `shortName` + # @return [String] + attr_accessor :short_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @disable_modifications = args[:disable_modifications] if args.key?(:disable_modifications) + @disable_serving = args[:disable_serving] if args.key?(:disable_serving) + @display_name = args[:display_name] if args.key?(:display_name) + @indexing_service_accounts = args[:indexing_service_accounts] if args.key?(:indexing_service_accounts) + @items_visibility = args[:items_visibility] if args.key?(:items_visibility) + @name = args[:name] if args.key?(:name) + @operation_ids = args[:operation_ids] if args.key?(:operation_ids) + @short_name = args[:short_name] if args.key?(:short_name) + end + end + + # Aggregation of items by status code as of the specified date. + class DataSourceIndexStats + include Google::Apis::Core::Hashable + + # Represents a whole calendar date, for example a date of birth. The time of day + # and time zone are either specified elsewhere or are not significant. The date + # is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/ + # wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date + # between the year 1 and 9999. + # Corresponds to the JSON property `date` + # @return [Google::Apis::CloudsearchV1::Date] + attr_accessor :date + + # Number of items aggregrated by status code. + # Corresponds to the JSON property `itemCountByStatus` + # @return [Array] + attr_accessor :item_count_by_status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @date = args[:date] if args.key?(:date) + @item_count_by_status = args[:item_count_by_status] if args.key?(:item_count_by_status) + end + end + + # Restriction on Datasource. + class DataSourceRestriction + include Google::Apis::Core::Hashable + + # Filter options restricting the results. If multiple filters + # are present, they are grouped by object type before joining. + # Filters with the same object type are joined conjunctively, then + # the resulting expressions are joined disjunctively. + # The maximum number of elements is 20. + # Corresponds to the JSON property `filterOptions` + # @return [Array] + attr_accessor :filter_options + + # Defines sources for the suggest/search APIs. + # Corresponds to the JSON property `source` + # @return [Google::Apis::CloudsearchV1::Source] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @filter_options = args[:filter_options] if args.key?(:filter_options) + @source = args[:source] if args.key?(:source) + end + end + + # Represents a whole calendar date, for example a date of birth. The time of day + # and time zone are either specified elsewhere or are not significant. The date + # is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/ + # wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date + # between the year 1 and 9999. + class Date + include Google::Apis::Core::Hashable + + # Day of month. Must be from 1 to 31 and valid for the year and month. + # Corresponds to the JSON property `day` + # @return [Fixnum] + attr_accessor :day + + # Month of date. Must be from 1 to 12. + # Corresponds to the JSON property `month` + # @return [Fixnum] + attr_accessor :month + + # Year of date. Must be from 1 to 9999. + # Corresponds to the JSON property `year` + # @return [Fixnum] + attr_accessor :year + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @day = args[:day] if args.key?(:day) + @month = args[:month] if args.key?(:month) + @year = args[:year] if args.key?(:year) + end + end + + # Optional. Provides a search operator for date properties. + # Search operators let users restrict the query to specific fields relevant + # to the type of item being searched. + class DateOperatorOptions + include Google::Apis::Core::Hashable + + # Indicates the operator name required in the query in order to isolate the + # date property using the greater-than operator. For example, if + # greaterThanOperatorName is *closedafter* and the property's name is + # *closeDate*, then queries like *closedafter:<value>* will + # show results only where the value of the property named *closeDate* is + # later than *<value>*. + # The operator name can only contain lowercase letters (a-z). + # The maximum length is 32 characters. + # Corresponds to the JSON property `greaterThanOperatorName` + # @return [String] + attr_accessor :greater_than_operator_name + + # Indicates the operator name required in the query in order to isolate the + # date property using the less-than operator. For example, if + # lessThanOperatorName is *closedbefore* and the property's name is + # *closeDate*, then queries like *closedbefore:<value>* will + # show results only where the value of the property named *closeDate* is + # earlier than *<value>*. + # The operator name can only contain lowercase letters (a-z). + # The maximum length is 32 characters. + # Corresponds to the JSON property `lessThanOperatorName` + # @return [String] + attr_accessor :less_than_operator_name + + # Indicates the actual string required in the query in order to isolate the + # date property. For example, suppose an issue tracking schema object + # has a property named *closeDate* that specifies an operator with an + # operatorName of *closedon*. For searches on that data, queries like + # *closedon:<value>* will show results only where the value of the + # *closeDate* property matches *<value>*. By contrast, a + # search that uses the same *<value>* without an operator will return + # all items where *<value>* matches the value of any String + # properties or text within the content field for the indexed datasource. + # The operator name can only contain lowercase letters (a-z). + # The maximum length is 32 characters. + # Corresponds to the JSON property `operatorName` + # @return [String] + attr_accessor :operator_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @greater_than_operator_name = args[:greater_than_operator_name] if args.key?(:greater_than_operator_name) + @less_than_operator_name = args[:less_than_operator_name] if args.key?(:less_than_operator_name) + @operator_name = args[:operator_name] if args.key?(:operator_name) + end + end + + # Options for date properties. + class DatePropertyOptions + include Google::Apis::Core::Hashable + + # Optional. Provides a search operator for date properties. + # Search operators let users restrict the query to specific fields relevant + # to the type of item being searched. + # Corresponds to the JSON property `operatorOptions` + # @return [Google::Apis::CloudsearchV1::DateOperatorOptions] + attr_accessor :operator_options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operator_options = args[:operator_options] if args.key?(:operator_options) + end + end + + # List of date values. + class DateValues + include Google::Apis::Core::Hashable + + # The maximum number of elements is 100. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @values = args[:values] if args.key?(:values) + end + end + + # Shared request debug options for all cloudsearch RPC methods. + class DebugOptions + include Google::Apis::Core::Hashable + + # If set, the request will enable debugging features of Cloud Search. + # Only turn on this field, if asked by Google to help with debugging. + # Corresponds to the JSON property `enableDebugging` + # @return [Boolean] + attr_accessor :enable_debugging + alias_method :enable_debugging?, :enable_debugging + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enable_debugging = args[:enable_debugging] if args.key?(:enable_debugging) + end + end + + # + class DeleteQueueItemsRequest + include Google::Apis::Core::Hashable + + # Name of connector making this call. + #
Format: datasources/`source_id`/connectors/`ID` + # Corresponds to the JSON property `connectorName` + # @return [String] + attr_accessor :connector_name + + # Shared request debug options for all cloudsearch RPC methods. + # Corresponds to the JSON property `debugOptions` + # @return [Google::Apis::CloudsearchV1::DebugOptions] + attr_accessor :debug_options + + # Name of a queue to delete items from. + # Corresponds to the JSON property `queue` + # @return [String] + attr_accessor :queue + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @connector_name = args[:connector_name] if args.key?(:connector_name) + @debug_options = args[:debug_options] if args.key?(:debug_options) + @queue = args[:queue] if args.key?(:queue) + end + end + + # A reference to a top-level property within the object that should be + # displayed in search results. The values of the chosen properties will be + # displayed in the search results along with the + # dislpay label + # for that property if one is specified. If a display label is not specified, + # only the values will be shown. + class DisplayedProperty + include Google::Apis::Core::Hashable + + # The name of the top-level property as defined in a property definition + # for the object. If the name is not a defined property in the schema, an + # error will be given when attempting to update the schema. + # Corresponds to the JSON property `propertyName` + # @return [String] + attr_accessor :property_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @property_name = args[:property_name] if args.key?(:property_name) + end + end + + # Used to provide a search operator for double properties. This is + # optional. Search operators let users restrict the query to specific fields + # relevant to the type of item being searched. + class DoubleOperatorOptions + include Google::Apis::Core::Hashable + + # Indicates the operator name required in the query in order to use the + # double property in sorting or as a facet. + # The operator name can only contain lowercase letters (a-z). + # The maximum length is 32 characters. + # Corresponds to the JSON property `operatorName` + # @return [String] + attr_accessor :operator_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operator_name = args[:operator_name] if args.key?(:operator_name) + end + end + + # Options for double properties. + class DoublePropertyOptions + include Google::Apis::Core::Hashable + + # Used to provide a search operator for double properties. This is + # optional. Search operators let users restrict the query to specific fields + # relevant to the type of item being searched. + # Corresponds to the JSON property `operatorOptions` + # @return [Google::Apis::CloudsearchV1::DoubleOperatorOptions] + attr_accessor :operator_options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operator_options = args[:operator_options] if args.key?(:operator_options) + end + end + + # List of double values. + class DoubleValues + include Google::Apis::Core::Hashable + + # The maximum number of elements is 100. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @values = args[:values] if args.key?(:values) + end + end + + # Drive follow-up search restricts (e.g. "followup:suggestions"). + class DriveFollowUpRestrict + include Google::Apis::Core::Hashable + + # + # 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) + @type = args[:type] if args.key?(:type) + end + end + + # Drive location search restricts (e.g. "is:starred"). + class DriveLocationRestrict + include Google::Apis::Core::Hashable + + # + # 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) + @type = args[:type] if args.key?(:type) + end + end + + # Drive mime-type search restricts (e.g. "type:pdf"). + class DriveMimeTypeRestrict + include Google::Apis::Core::Hashable + + # + # 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) + @type = args[:type] if args.key?(:type) + end + end + + # The time span search restrict (e.g. "after:2017-09-11 before:2017-09-12"). + class DriveTimeSpanRestrict + include Google::Apis::Core::Hashable + + # + # 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) + @type = args[:type] if args.key?(:type) + end + end + + # A person's email address. + class EmailAddress + include Google::Apis::Core::Hashable + + # The email address. + # Corresponds to the JSON property `emailAddress` + # @return [String] + attr_accessor :email_address + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @email_address = args[:email_address] if args.key?(:email_address) + end + end + + # Used to provide a search operator for enum properties. This is + # optional. Search operators let users restrict the query to specific fields + # relevant to the type of item being searched. For example, if you provide no + # operator for a *priority* enum property with possible values *p0* and *p1*, + # a query that contains the term *p0* will return items that have *p0* as the + # value of the *priority* property, as well as any items that contain the + # string *p0* in other fields. If you provide an operator name for the enum, + # such as *priority*, then search users can use that operator to refine + # results to only items that have *p0* as this property's value, with the + # query *priority:p0*. + class EnumOperatorOptions + include Google::Apis::Core::Hashable + + # Indicates the operator name required in the query in order to isolate the + # enum property. For example, if operatorName is *priority* and the + # property's name is *priorityVal*, then queries like + # *priority:<value>* will show results only where the value of the + # property named *priorityVal* matches *<value>*. By contrast, a + # search that uses the same *<value>* without an operator will return + # all items where *<value>* matches the value of any String + # properties or text within the content field for the item. + # The operator name can only contain lowercase letters (a-z). + # The maximum length is 32 characters. + # Corresponds to the JSON property `operatorName` + # @return [String] + attr_accessor :operator_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operator_name = args[:operator_name] if args.key?(:operator_name) + end + end + + # Options for enum properties, which allow you to define a restricted set of + # strings to match user queries, set rankings for those string values, and + # define an operator name to be paired with those strings so that users can + # narrow results to only items with a specific value. For example, for items in + # a request tracking system with priority information, you could define *p0* as + # an allowable enum value and tie this enum to the operator name *priority* so + # that search users could add *priority:p0* to their query to restrict the set + # of results to only those items indexed with the value *p0*. + class EnumPropertyOptions + include Google::Apis::Core::Hashable + + # Used to provide a search operator for enum properties. This is + # optional. Search operators let users restrict the query to specific fields + # relevant to the type of item being searched. For example, if you provide no + # operator for a *priority* enum property with possible values *p0* and *p1*, + # a query that contains the term *p0* will return items that have *p0* as the + # value of the *priority* property, as well as any items that contain the + # string *p0* in other fields. If you provide an operator name for the enum, + # such as *priority*, then search users can use that operator to refine + # results to only items that have *p0* as this property's value, with the + # query *priority:p0*. + # Corresponds to the JSON property `operatorOptions` + # @return [Google::Apis::CloudsearchV1::EnumOperatorOptions] + attr_accessor :operator_options + + # Used to specify the ordered ranking for the enumeration that determines how + # the integer values provided in the possible EnumValuePairs are used to rank + # results. If specified, integer values must be provided for all possible + # EnumValuePair values given for this property. Can only be used if + # isRepeatable + # is false. + # Corresponds to the JSON property `orderedRanking` + # @return [String] + attr_accessor :ordered_ranking + + # The list of possible values for the enumeration property. All + # EnumValuePairs must provide a string value. If you specify an integer value + # for one EnumValuePair, then all possible EnumValuePairs must provide an + # integer value. Both the string value and integer value must be unique over + # all possible values. Once set, possible values cannot be removed or + # modified. If you supply an ordered ranking and think you might insert + # additional enum values in the future, leave gaps in the initial integer + # values to allow adding a value in between previously registered values. + # The maximum number of elements is 100. + # Corresponds to the JSON property `possibleValues` + # @return [Array] + attr_accessor :possible_values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operator_options = args[:operator_options] if args.key?(:operator_options) + @ordered_ranking = args[:ordered_ranking] if args.key?(:ordered_ranking) + @possible_values = args[:possible_values] if args.key?(:possible_values) + end + end + + # The enumeration value pair defines two things: a required string value and + # an optional integer value. The string value defines the necessary query + # term required to retrieve that item, such as *p0* for a priority item. + # The integer value determines the ranking of that string value relative + # to other enumerated values for the same property. For example, you might + # associate *p0* with *0* and define another enum pair such as *p1* and *1*. + # You must use the integer value in combination with + # ordered + # ranking to + # set the ranking of a given value relative to other enumerated values for + # the same property name. Here, a ranking order of DESCENDING for *priority* + # properties results in a ranking boost for items indexed with a value of + # *p0* compared to items indexed with a value of *p1*. Without a specified + # ranking order, the integer value has no effect on item ranking. + class EnumValuePair + include Google::Apis::Core::Hashable + + # The integer value of the EnumValuePair which must be non-negative. + # Optional. + # Corresponds to the JSON property `integerValue` + # @return [Fixnum] + attr_accessor :integer_value + + # The string value of the EnumValuePair. + # The maximum length is 32 characters. + # 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) + @integer_value = args[:integer_value] if args.key?(:integer_value) + @string_value = args[:string_value] if args.key?(:string_value) + end + end + + # List of enum values. + class EnumValues + include Google::Apis::Core::Hashable + + # The maximum allowable length for string values is 32 characters. + # The maximum number of elements is 100. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @values = args[:values] if args.key?(:values) + end + end + + # Error information about the response. + class ErrorInfo + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `errorMessages` + # @return [Array] + attr_accessor :error_messages + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @error_messages = args[:error_messages] if args.key?(:error_messages) + end + end + + # Error message per source response. + class ErrorMessage + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `errorMessage` + # @return [String] + attr_accessor :error_message + + # Defines sources for the suggest/search APIs. + # Corresponds to the JSON property `source` + # @return [Google::Apis::CloudsearchV1::Source] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @error_message = args[:error_message] if args.key?(:error_message) + @source = args[:source] if args.key?(:source) + end + end + + # A bucket in a facet is the basic unit of operation. A bucket can comprise + # either a single value OR a contiguous range of values, depending on the + # type of the field bucketed. + # FacetBucket is currently used only for returning the response object. + class FacetBucket + include Google::Apis::Core::Hashable + + # Number of results that match the bucket value. + # Corresponds to the JSON property `count` + # @return [Fixnum] + attr_accessor :count + + # Percent of results that match the bucket value. This value is between + # (0-100]. + # This may not be accurate and is a best effort estimate. + # Corresponds to the JSON property `percentage` + # @return [Fixnum] + attr_accessor :percentage + + # Definition of a single value with generic type. + # Corresponds to the JSON property `value` + # @return [Google::Apis::CloudsearchV1::Value] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @count = args[:count] if args.key?(:count) + @percentage = args[:percentage] if args.key?(:percentage) + @value = args[:value] if args.key?(:value) + end + end + + # Specifies operators to return facet results for. There will be one + # FacetResult for every source_name/object_type/operator_name combination. + class FacetOptions + include Google::Apis::Core::Hashable + + # If object_type is set, only those objects of that type will be used to + # compute facets. If empty, then all objects will be used to compute facets. + # Corresponds to the JSON property `objectType` + # @return [String] + attr_accessor :object_type + + # Name of the operator chosen for faceting. @see + # cloudsearch.SchemaPropertyOptions + # Corresponds to the JSON property `operatorName` + # @return [String] + attr_accessor :operator_name + + # Source name to facet on. Format: datasources/`source_id` + # If empty, all data sources will be used. + # Corresponds to the JSON property `sourceName` + # @return [String] + attr_accessor :source_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @object_type = args[:object_type] if args.key?(:object_type) + @operator_name = args[:operator_name] if args.key?(:operator_name) + @source_name = args[:source_name] if args.key?(:source_name) + end + end + + # Source specific facet response + class FacetResult + include Google::Apis::Core::Hashable + + # FacetBuckets for values in response containing atleast a single result. + # Corresponds to the JSON property `buckets` + # @return [Array] + attr_accessor :buckets + + # Object type for which facet results are returned. Can be empty. + # Corresponds to the JSON property `objectType` + # @return [String] + attr_accessor :object_type + + # Name of the operator chosen for faceting. @see + # cloudsearch.SchemaPropertyOptions + # Corresponds to the JSON property `operatorName` + # @return [String] + attr_accessor :operator_name + + # Source name for which facet results are returned. Will not be empty. + # Corresponds to the JSON property `sourceName` + # @return [String] + attr_accessor :source_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @buckets = args[:buckets] if args.key?(:buckets) + @object_type = args[:object_type] if args.key?(:object_type) + @operator_name = args[:operator_name] if args.key?(:operator_name) + @source_name = args[:source_name] if args.key?(:source_name) + end + end + + # + class FieldViolation + include Google::Apis::Core::Hashable + + # Description of the error. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # Path of field with violation. + # Corresponds to the JSON property `field` + # @return [String] + attr_accessor :field + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @field = args[:field] if args.key?(:field) + end + end + + # A generic way of expressing filters in a query, which supports two + # approaches:

+ # **1. Setting a ValueFilter.** The name must match an operator_name defined in + # the schema for your data source. + #
+ # **2. Setting a CompositeFilter.** The filters are evaluated + # using the logical operator. The top-level operators can only be either an AND + # or a NOT. AND can appear only at the top-most level. OR can appear only under + # a top-level AND. + class Filter + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `compositeFilter` + # @return [Google::Apis::CloudsearchV1::CompositeFilter] + attr_accessor :composite_filter + + # + # Corresponds to the JSON property `valueFilter` + # @return [Google::Apis::CloudsearchV1::ValueFilter] + attr_accessor :value_filter + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @composite_filter = args[:composite_filter] if args.key?(:composite_filter) + @value_filter = args[:value_filter] if args.key?(:value_filter) + end + end + + # Filter options to be applied on query. + class FilterOptions + include Google::Apis::Core::Hashable + + # A generic way of expressing filters in a query, which supports two + # approaches:

+ # **1. Setting a ValueFilter.** The name must match an operator_name defined in + # the schema for your data source. + #
+ # **2. Setting a CompositeFilter.** The filters are evaluated + # using the logical operator. The top-level operators can only be either an AND + # or a NOT. AND can appear only at the top-most level. OR can appear only under + # a top-level AND. + # Corresponds to the JSON property `filter` + # @return [Google::Apis::CloudsearchV1::Filter] + attr_accessor :filter + + # If object_type is set, only objects of that type are returned. This should + # correspond to the name of the object that was registered within the + # definition of schema. The maximum length is 256 characters. + # 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) + @filter = args[:filter] if args.key?(:filter) + @object_type = args[:object_type] if args.key?(:object_type) + end + end + + # Indicates which freshness property to use when adjusting search ranking for + # an item. Fresher, more recent dates indicate higher quality. Use the + # freshness option property that best works with your data. For fileshare + # documents, last modified time is most relevant. For calendar event data, + # the time when the event occurs is a more relevant freshness indicator. In + # this way, calendar events that occur closer to the time of the search query + # are considered higher quality and ranked accordingly. + class FreshnessOptions + include Google::Apis::Core::Hashable + + # The duration (in seconds) after which an object should be considered + # stale. + # Corresponds to the JSON property `freshnessDuration` + # @return [String] + attr_accessor :freshness_duration + + # This property indicates the freshness level of the object in the index. + # If set, this property must be a top-level property within the + # PropertyDefinitions + # and it must be a + # timestamp type + # or + # date type. + # Otherwise, the Indexing API uses + # updateTime + # as the freshness indicator. + # The maximum length is 256 characters. + # Corresponds to the JSON property `freshnessProperty` + # @return [String] + attr_accessor :freshness_property + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @freshness_duration = args[:freshness_duration] if args.key?(:freshness_duration) + @freshness_property = args[:freshness_property] if args.key?(:freshness_property) + end + end + + # + class GSuitePrincipal + include Google::Apis::Core::Hashable + + # This principal represents all users of the G Suite domain of the + # customer. + # Corresponds to the JSON property `gsuiteDomain` + # @return [Boolean] + attr_accessor :gsuite_domain + alias_method :gsuite_domain?, :gsuite_domain + + # This principal references a G Suite group account + # Corresponds to the JSON property `gsuiteGroupEmail` + # @return [String] + attr_accessor :gsuite_group_email + + # This principal references a G Suite user account + # Corresponds to the JSON property `gsuiteUserEmail` + # @return [String] + attr_accessor :gsuite_user_email + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gsuite_domain = args[:gsuite_domain] if args.key?(:gsuite_domain) + @gsuite_group_email = args[:gsuite_group_email] if args.key?(:gsuite_group_email) + @gsuite_user_email = args[:gsuite_user_email] if args.key?(:gsuite_user_email) + end + end + + # + class GetCustomerIndexStatsResponse + include Google::Apis::Core::Hashable + + # Summary of indexed item counts, one for each day in the requested range. + # Corresponds to the JSON property `stats` + # @return [Array] + attr_accessor :stats + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @stats = args[:stats] if args.key?(:stats) + end + end + + # + class GetDataSourceIndexStatsResponse + include Google::Apis::Core::Hashable + + # Summary of indexed item counts, one for each day in the requested range. + # Corresponds to the JSON property `stats` + # @return [Array] + attr_accessor :stats + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @stats = args[:stats] if args.key?(:stats) + end + end + + # Used to provide a search operator for html properties. This is optional. + # Search operators let users restrict the query to specific fields relevant + # to the type of item being searched. + class HtmlOperatorOptions + include Google::Apis::Core::Hashable + + # Indicates the operator name required in the query in order to isolate the + # html property. For example, if operatorName is *subject* and the + # property's name is *subjectLine*, then queries like + # *subject:<value>* will show results only where the value of the + # property named *subjectLine* matches *<value>*. By contrast, a + # search that uses the same *<value>* without an operator will return + # all items where *<value>* matches the value of any + # html properties or text within the content field for the item. + # The operator name can only contain lowercase letters (a-z). + # The maximum length is 32 characters. + # Corresponds to the JSON property `operatorName` + # @return [String] + attr_accessor :operator_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operator_name = args[:operator_name] if args.key?(:operator_name) + end + end + + # Options for html properties. + class HtmlPropertyOptions + include Google::Apis::Core::Hashable + + # Used to provide a search operator for html properties. This is optional. + # Search operators let users restrict the query to specific fields relevant + # to the type of item being searched. + # Corresponds to the JSON property `operatorOptions` + # @return [Google::Apis::CloudsearchV1::HtmlOperatorOptions] + attr_accessor :operator_options + + # Indicates the search quality importance of the tokens within the + # field when used for retrieval. Can only be set to DEFAULT or NONE. + # Corresponds to the JSON property `retrievalImportance` + # @return [Google::Apis::CloudsearchV1::RetrievalImportance] + attr_accessor :retrieval_importance + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operator_options = args[:operator_options] if args.key?(:operator_options) + @retrieval_importance = args[:retrieval_importance] if args.key?(:retrieval_importance) + end + end + + # List of html values. + class HtmlValues + include Google::Apis::Core::Hashable + + # The maximum allowable length for html values is 2048 characters. + # The maximum number of string elements is 100. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @values = args[:values] if args.key?(:values) + end + end + + # + class IndexItemRequest + include Google::Apis::Core::Hashable + + # Name of connector making this call. + #
Format: datasources/`source_id`/connectors/`ID` + # Corresponds to the JSON property `connectorName` + # @return [String] + attr_accessor :connector_name + + # Shared request debug options for all cloudsearch RPC methods. + # Corresponds to the JSON property `debugOptions` + # @return [Google::Apis::CloudsearchV1::DebugOptions] + attr_accessor :debug_options + + # Represents a single object that is an item in the search index, such as a + # file, folder, or a database record. + # Corresponds to the JSON property `item` + # @return [Google::Apis::CloudsearchV1::Item] + attr_accessor :item + + # Required. The RequestMode for this request. + # Corresponds to the JSON property `mode` + # @return [String] + attr_accessor :mode + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @connector_name = args[:connector_name] if args.key?(:connector_name) + @debug_options = args[:debug_options] if args.key?(:debug_options) + @item = args[:item] if args.key?(:item) + @mode = args[:mode] if args.key?(:mode) + end + end + + # Used to provide a search operator for integer properties. This is + # optional. Search operators let users restrict the query to specific fields + # relevant to the type of item being searched. + class IntegerOperatorOptions + include Google::Apis::Core::Hashable + + # Indicates the operator name required in the query in order to isolate the + # integer property using the greater-than operator. For example, if + # greaterThanOperatorName is *priorityabove* and the property's name is + # *priorityVal*, then queries like *priorityabove:<value>* will + # show results only where the value of the property named *priorityVal* is + # greater than *<value>*. + # The operator name can only contain lowercase letters (a-z). + # The maximum length is 32 characters. + # Corresponds to the JSON property `greaterThanOperatorName` + # @return [String] + attr_accessor :greater_than_operator_name + + # Indicates the operator name required in the query in order to isolate the + # integer property using the less-than operator. For example, if + # lessThanOperatorName is *prioritybelow* and the property's name is + # *priorityVal*, then queries like *prioritybelow:<value>* will + # show results only where the value of the property named *priorityVal* is + # less than *<value>*. + # The operator name can only contain lowercase letters (a-z). + # The maximum length is 32 characters. + # Corresponds to the JSON property `lessThanOperatorName` + # @return [String] + attr_accessor :less_than_operator_name + + # Indicates the operator name required in the query in order to isolate the + # integer property. For example, if operatorName is *priority* and the + # property's name is *priorityVal*, then queries like + # *priority:<value>* will show results only where the value of the + # property named *priorityVal* matches *<value>*. By contrast, a + # search that uses the same *<value>* without an operator will return + # all items where *<value>* matches the value of any String + # properties or text within the content field for the item. + # The operator name can only contain lowercase letters (a-z). + # The maximum length is 32 characters. + # Corresponds to the JSON property `operatorName` + # @return [String] + attr_accessor :operator_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @greater_than_operator_name = args[:greater_than_operator_name] if args.key?(:greater_than_operator_name) + @less_than_operator_name = args[:less_than_operator_name] if args.key?(:less_than_operator_name) + @operator_name = args[:operator_name] if args.key?(:operator_name) + end + end + + # Options for integer properties. + class IntegerPropertyOptions + include Google::Apis::Core::Hashable + + # The maximum value of the property. The minimum and maximum values for the + # property are used to rank results according to the + # ordered ranking. + # Indexing requests with values greater than the maximum are accepted and + # ranked with the same weight as items indexed with the maximum value. + # Corresponds to the JSON property `maximumValue` + # @return [Fixnum] + attr_accessor :maximum_value + + # The minimum value of the property. The minimum and maximum values for the + # property are used to rank results according to the + # ordered ranking. + # Indexing requests with values less than the minimum are accepted and + # ranked with the same weight as items indexed with the minimum value. + # Corresponds to the JSON property `minimumValue` + # @return [Fixnum] + attr_accessor :minimum_value + + # Used to provide a search operator for integer properties. This is + # optional. Search operators let users restrict the query to specific fields + # relevant to the type of item being searched. + # Corresponds to the JSON property `operatorOptions` + # @return [Google::Apis::CloudsearchV1::IntegerOperatorOptions] + attr_accessor :operator_options + + # Used to specify the ordered ranking for the integer. Can only be used if + # isRepeatable + # is false. + # Corresponds to the JSON property `orderedRanking` + # @return [String] + attr_accessor :ordered_ranking + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @maximum_value = args[:maximum_value] if args.key?(:maximum_value) + @minimum_value = args[:minimum_value] if args.key?(:minimum_value) + @operator_options = args[:operator_options] if args.key?(:operator_options) + @ordered_ranking = args[:ordered_ranking] if args.key?(:ordered_ranking) + end + end + + # List of integer values. + class IntegerValues + include Google::Apis::Core::Hashable + + # The maximum number of elements is 100. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @values = args[:values] if args.key?(:values) + end + end + + # Represents an interaction between a user and an item. + class Interaction + include Google::Apis::Core::Hashable + + # The time when the user acted on the item. If multiple actions of the same + # type exist for a single user, only the most recent action is recorded. + # Corresponds to the JSON property `interactionTime` + # @return [String] + attr_accessor :interaction_time + + # Reference to a user, group, or domain. + # Corresponds to the JSON property `principal` + # @return [Google::Apis::CloudsearchV1::Principal] + attr_accessor :principal + + # + # 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) + @interaction_time = args[:interaction_time] if args.key?(:interaction_time) + @principal = args[:principal] if args.key?(:principal) + @type = args[:type] if args.key?(:type) + end + end + + # Represents a single object that is an item in the search index, such as a + # file, folder, or a database record. + class Item + include Google::Apis::Core::Hashable + + # Access control list information for the item. For more information see + # https://developers.google.com/cloud-search/docs/guides/index-your-data#acls + # Corresponds to the JSON property `acl` + # @return [Google::Apis::CloudsearchV1::ItemAcl] + attr_accessor :acl + + # Content of an item to be indexed and surfaced by Cloud Search. + # Corresponds to the JSON property `content` + # @return [Google::Apis::CloudsearchV1::ItemContent] + attr_accessor :content + + # Type for this item. + # Corresponds to the JSON property `itemType` + # @return [String] + attr_accessor :item_type + + # Available metadata fields for the item. + # Corresponds to the JSON property `metadata` + # @return [Google::Apis::CloudsearchV1::ItemMetadata] + attr_accessor :metadata + + # Name of the Item. Format: + # datasources/`source_id`/items/`item_id` + #
This is a required field. + # The maximum length is 1536 characters. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Additional state connector can store for this item. + # The maximum length is 10000 bytes. + # Corresponds to the JSON property `payload` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :payload + + # Queue this item belongs to. + # The maximum length is 100 characters. + # Corresponds to the JSON property `queue` + # @return [String] + attr_accessor :queue + + # This contains item's status and any errors. + # Corresponds to the JSON property `status` + # @return [Google::Apis::CloudsearchV1::ItemStatus] + attr_accessor :status + + # Available structured data fields for the item. + # Corresponds to the JSON property `structuredData` + # @return [Google::Apis::CloudsearchV1::ItemStructuredData] + attr_accessor :structured_data + + # Required. The indexing system stores the version from the datasource as a + # byte string and compares the Item version in the index + # to the version of the queued Item using lexical ordering. + #

+ # Cloud Search Indexing won't index or delete any queued item with + # a version value that is less than or equal to the version of the + # currently indexed item. + # The maximum length for this field is 1024 bytes. + # Corresponds to the JSON property `version` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @acl = args[:acl] if args.key?(:acl) + @content = args[:content] if args.key?(:content) + @item_type = args[:item_type] if args.key?(:item_type) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @payload = args[:payload] if args.key?(:payload) + @queue = args[:queue] if args.key?(:queue) + @status = args[:status] if args.key?(:status) + @structured_data = args[:structured_data] if args.key?(:structured_data) + @version = args[:version] if args.key?(:version) + end + end + + # Access control list information for the item. For more information see + # https://developers.google.com/cloud-search/docs/guides/index-your-data#acls + class ItemAcl + include Google::Apis::Core::Hashable + + # Sets the type of access rules to apply when an item inherits its ACL from a + # parent. This should always be set in tandem with the + # inheritAclFrom + # field. Also, when the + # inheritAclFrom field + # is set, this field should be set to a valid AclInheritanceType. + # Corresponds to the JSON property `aclInheritanceType` + # @return [String] + attr_accessor :acl_inheritance_type + + # List of principals who are explicitly denied access to the item in search + # results. While principals are denied access by default, use denied readers + # to handle exceptions and override the list allowed readers. + # The maximum number of elements is 100. + # Corresponds to the JSON property `deniedReaders` + # @return [Array] + attr_accessor :denied_readers + + # Name of the item to inherit the Access Permission List (ACL) from. + # Note: ACL inheritance *only* provides access permissions + # to child items and does not define structural relationships, nor does it + # provide convenient ways to delete large groups of items. + # Deleting an ACL parent from the index only alters the access permissions of + # child items that reference the parent in the + # inheritAclFrom + # field. The item is still in the index, but may not + # visible in search results. By contrast, deletion of a container item + # also deletes all items that reference the container via the + # containerName + # field. + # The maximum length for this field is 1536 characters. + # Corresponds to the JSON property `inheritAclFrom` + # @return [String] + attr_accessor :inherit_acl_from + + # Optional. List of owners for the item. This field has no bearing on + # document access permissions. It does, however, offer + # a slight ranking boosts items where the querying user is an owner. + # The maximum number of elements is 5. + # Corresponds to the JSON property `owners` + # @return [Array] + attr_accessor :owners + + # List of principals who are allowed to see the item in search results. + # Optional if inheriting permissions from another item or if the item + # is not intended to be visible, such as + # virtual containers. + # The maximum number of elements is 1000. + # Corresponds to the JSON property `readers` + # @return [Array] + attr_accessor :readers + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @acl_inheritance_type = args[:acl_inheritance_type] if args.key?(:acl_inheritance_type) + @denied_readers = args[:denied_readers] if args.key?(:denied_readers) + @inherit_acl_from = args[:inherit_acl_from] if args.key?(:inherit_acl_from) + @owners = args[:owners] if args.key?(:owners) + @readers = args[:readers] if args.key?(:readers) + end + end + + # Content of an item to be indexed and surfaced by Cloud Search. + class ItemContent + include Google::Apis::Core::Hashable + + # Represents an upload session reference. + # This reference is created via upload + # method. + # Updating of item content may refer to this uploaded content via + # contentDataRef. + # Corresponds to the JSON property `contentDataRef` + # @return [Google::Apis::CloudsearchV1::UploadItemRef] + attr_accessor :content_data_ref + + # + # Corresponds to the JSON property `contentFormat` + # @return [String] + attr_accessor :content_format + + # Hashing info calculated and provided by the API client for content. + # Can be used with the items.push method to calculate modified state. + # The maximum length is 2048 characters. + # Corresponds to the JSON property `hash` + # @return [String] + attr_accessor :hash_prop + + # Content that is supplied inlined within the update method. + # The maximum length is 102400 bytes (100 KiB). + # Corresponds to the JSON property `inlineContent` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :inline_content + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content_data_ref = args[:content_data_ref] if args.key?(:content_data_ref) + @content_format = args[:content_format] if args.key?(:content_format) + @hash_prop = args[:hash_prop] if args.key?(:hash_prop) + @inline_content = args[:inline_content] if args.key?(:inline_content) + end + end + + # + class ItemCountByStatus + include Google::Apis::Core::Hashable + + # Number of items matching the status code. + # Corresponds to the JSON property `count` + # @return [Fixnum] + attr_accessor :count + + # Status of the items. + # Corresponds to the JSON property `statusCode` + # @return [String] + attr_accessor :status_code + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @count = args[:count] if args.key?(:count) + @status_code = args[:status_code] if args.key?(:status_code) + end + end + + # Available metadata fields for the item. + class ItemMetadata + include Google::Apis::Core::Hashable + + # The name of the container for this item. + # Deletion of the container item leads to automatic deletion of this + # item. Note: ACLs are not inherited from a container item. + # To provide ACL inheritance for an item, use the + # inheritAclFrom + # field. The maximum length is 1536 characters. + # Corresponds to the JSON property `containerName` + # @return [String] + attr_accessor :container_name + + # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For + # more information, see + # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The maximum length is 32 characters. + # Corresponds to the JSON property `contentLanguage` + # @return [String] + attr_accessor :content_language + + # The time when the item was created in the source repository. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Hashing value provided by the API caller. + # This can be used with the + # items.push + # method to calculate modified state. + # The maximum length is 2048 characters. + # Corresponds to the JSON property `hash` + # @return [String] + attr_accessor :hash_prop + + # A list of interactions for the item. Interactions are used to improve + # Search quality, but are not exposed to end users. + # The maximum number of elements is 1000. + # Corresponds to the JSON property `interactions` + # @return [Array] + attr_accessor :interactions + + # Additional keywords or phrases that should match the item. + # Used internally for user generated content. + # The maximum number of elements is 100. + # The maximum length is 8192 characters. + # Corresponds to the JSON property `keywords` + # @return [Array] + attr_accessor :keywords + + # The original mime-type of + # ItemContent.content + # in the source repository. + # The maximum length is 256 characters. + # Corresponds to the JSON property `mimeType` + # @return [String] + attr_accessor :mime_type + + # The type of the item. This should correspond to the name of an object + # definition in the schema registered for the data source. For example, if + # the schema for the data source contains an object definition with name + # 'document', then item indexing requests for objects of that type should set + # objectType to 'document'. + # The maximum length is 256 characters. + # Corresponds to the JSON property `objectType` + # @return [String] + attr_accessor :object_type + + # Additional search quality metadata of the item. + # Corresponds to the JSON property `searchQualityMetadata` + # @return [Google::Apis::CloudsearchV1::SearchQualityMetadata] + attr_accessor :search_quality_metadata + + # Link to the source repository serving the data. Search results apply + # this link to the title. + # The maximum length is 2048 characters. + # Corresponds to the JSON property `sourceRepositoryUrl` + # @return [String] + attr_accessor :source_repository_url + + # The title of the item. If given, this will be the displayed title of the + # Search result. + # The maximum length is 2048 characters. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # The time when the item was last modified in the source repository. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @container_name = args[:container_name] if args.key?(:container_name) + @content_language = args[:content_language] if args.key?(:content_language) + @create_time = args[:create_time] if args.key?(:create_time) + @hash_prop = args[:hash_prop] if args.key?(:hash_prop) + @interactions = args[:interactions] if args.key?(:interactions) + @keywords = args[:keywords] if args.key?(:keywords) + @mime_type = args[:mime_type] if args.key?(:mime_type) + @object_type = args[:object_type] if args.key?(:object_type) + @search_quality_metadata = args[:search_quality_metadata] if args.key?(:search_quality_metadata) + @source_repository_url = args[:source_repository_url] if args.key?(:source_repository_url) + @title = args[:title] if args.key?(:title) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # This contains item's status and any errors. + class ItemStatus + include Google::Apis::Core::Hashable + + # Status code. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # Error details in case the item is in ERROR state. + # Corresponds to the JSON property `processingErrors` + # @return [Array] + attr_accessor :processing_errors + + # Repository error reported by connector. + # Corresponds to the JSON property `repositoryErrors` + # @return [Array] + attr_accessor :repository_errors + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @processing_errors = args[:processing_errors] if args.key?(:processing_errors) + @repository_errors = args[:repository_errors] if args.key?(:repository_errors) + end + end + + # Available structured data fields for the item. + class ItemStructuredData + include Google::Apis::Core::Hashable + + # Hashing value provided by the API caller. + # This can be used with the + # items.push + # method to calculate modified state. + # The maximum length is 2048 characters. + # Corresponds to the JSON property `hash` + # @return [String] + attr_accessor :hash_prop + + # A structured data object consisting of named properties. + # Corresponds to the JSON property `object` + # @return [Google::Apis::CloudsearchV1::StructuredDataObject] + attr_accessor :object + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @hash_prop = args[:hash_prop] if args.key?(:hash_prop) + @object = args[:object] if args.key?(:object) + end + end + + # + class ListDataSourceResponse + 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 + + # + # Corresponds to the JSON property `sources` + # @return [Array] + attr_accessor :sources + + 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) + @sources = args[:sources] if args.key?(:sources) + end + end + + # + class ListItemNamesForUnmappedIdentityResponse + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `itemNames` + # @return [Array] + attr_accessor :item_names + + # 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) + @item_names = args[:item_names] if args.key?(:item_names) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # + class ListItemsResponse + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # 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) + @items = args[:items] if args.key?(:items) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # List sources response. + class ListQuerySourcesResponse + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # + # Corresponds to the JSON property `sources` + # @return [Array] + attr_accessor :sources + + 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) + @sources = args[:sources] if args.key?(:sources) + end + end + + # + class ListSearchApplicationsResponse + 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 + + # + # Corresponds to the JSON property `searchApplications` + # @return [Array] + attr_accessor :search_applications + + 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) + @search_applications = args[:search_applications] if args.key?(:search_applications) + end + end + + # + class ListUnmappedIdentitiesResponse + 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 + + # + # Corresponds to the JSON property `unmappedIdentities` + # @return [Array] + attr_accessor :unmapped_identities + + 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) + @unmapped_identities = args[:unmapped_identities] if args.key?(:unmapped_identities) + end + end + + # Matched range of a snippet [start, end). + class MatchRange + include Google::Apis::Core::Hashable + + # End of the match in the snippet. + # Corresponds to the JSON property `end` + # @return [Fixnum] + attr_accessor :end + + # Starting position of the match in the snippet. + # Corresponds to the JSON property `start` + # @return [Fixnum] + attr_accessor :start + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end = args[:end] if args.key?(:end) + @start = args[:start] if args.key?(:start) + end + end + + # Media resource. + class Media + include Google::Apis::Core::Hashable + + # Name of the media resource. + # Corresponds to the JSON property `resourceName` + # @return [String] + attr_accessor :resource_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @resource_name = args[:resource_name] if args.key?(:resource_name) + end + end + + # Metadata of a matched search result. + class Metadata + include Google::Apis::Core::Hashable + + # The creation time for this document or object in the search result. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # Options that specify how to display a structured data search result. + # Corresponds to the JSON property `displayOptions` + # @return [Google::Apis::CloudsearchV1::ResultDisplayMetadata] + attr_accessor :display_options + + # Indexed fields in structured data, returned as a generic named property. + # Corresponds to the JSON property `fields` + # @return [Array] + attr_accessor :fields + + # Mime type of the search result. + # Corresponds to the JSON property `mimeType` + # @return [String] + attr_accessor :mime_type + + # Object type of the search result. + # Corresponds to the JSON property `objectType` + # @return [String] + attr_accessor :object_type + + # Object to represent a person. + # Corresponds to the JSON property `owner` + # @return [Google::Apis::CloudsearchV1::Person] + attr_accessor :owner + + # Defines sources for the suggest/search APIs. + # Corresponds to the JSON property `source` + # @return [Google::Apis::CloudsearchV1::Source] + attr_accessor :source + + # The last modified date for the object in the search result. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @create_time = args[:create_time] if args.key?(:create_time) + @display_options = args[:display_options] if args.key?(:display_options) + @fields = args[:fields] if args.key?(:fields) + @mime_type = args[:mime_type] if args.key?(:mime_type) + @object_type = args[:object_type] if args.key?(:object_type) + @owner = args[:owner] if args.key?(:owner) + @source = args[:source] if args.key?(:source) + @update_time = args[:update_time] if args.key?(:update_time) + end + end + + # A metaline is a list of properties that are displayed along with the search + # result to provide context. + class Metaline + include Google::Apis::Core::Hashable + + # The list of displayed properties for the metaline. + # Corresponds to the JSON property `properties` + # @return [Array] + attr_accessor :properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @properties = args[:properties] if args.key?(:properties) + end + end + + # A person's name. + class Name + include Google::Apis::Core::Hashable + + # The read-only display name formatted according to the locale specified by + # the viewer's account or the Accept-Language HTTP header. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + end + end + + # A typed name-value pair for structured data. The type of the value should + # be the same as the registered type for the `name` property in the object + # definition of `objectType`. + class NamedProperty + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `booleanValue` + # @return [Boolean] + attr_accessor :boolean_value + alias_method :boolean_value?, :boolean_value + + # List of date values. + # Corresponds to the JSON property `dateValues` + # @return [Google::Apis::CloudsearchV1::DateValues] + attr_accessor :date_values + + # List of double values. + # Corresponds to the JSON property `doubleValues` + # @return [Google::Apis::CloudsearchV1::DoubleValues] + attr_accessor :double_values + + # List of enum values. + # Corresponds to the JSON property `enumValues` + # @return [Google::Apis::CloudsearchV1::EnumValues] + attr_accessor :enum_values + + # List of html values. + # Corresponds to the JSON property `htmlValues` + # @return [Google::Apis::CloudsearchV1::HtmlValues] + attr_accessor :html_values + + # List of integer values. + # Corresponds to the JSON property `integerValues` + # @return [Google::Apis::CloudsearchV1::IntegerValues] + attr_accessor :integer_values + + # The name of the property. This name should correspond to the name of the + # property that was registered for object definition in the schema. + # The maximum allowable length for this property is 256 characters. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # List of object values. + # Corresponds to the JSON property `objectValues` + # @return [Google::Apis::CloudsearchV1::ObjectValues] + attr_accessor :object_values + + # List of text values. + # Corresponds to the JSON property `textValues` + # @return [Google::Apis::CloudsearchV1::TextValues] + attr_accessor :text_values + + # List of timestamp values. + # Corresponds to the JSON property `timestampValues` + # @return [Google::Apis::CloudsearchV1::TimestampValues] + attr_accessor :timestamp_values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @boolean_value = args[:boolean_value] if args.key?(:boolean_value) + @date_values = args[:date_values] if args.key?(:date_values) + @double_values = args[:double_values] if args.key?(:double_values) + @enum_values = args[:enum_values] if args.key?(:enum_values) + @html_values = args[:html_values] if args.key?(:html_values) + @integer_values = args[:integer_values] if args.key?(:integer_values) + @name = args[:name] if args.key?(:name) + @object_values = args[:object_values] if args.key?(:object_values) + @text_values = args[:text_values] if args.key?(:text_values) + @timestamp_values = args[:timestamp_values] if args.key?(:timestamp_values) + end + end + + # The definition for an object within a data source. + class ObjectDefinition + include Google::Apis::Core::Hashable + + # Name for the object, which then defines its type. Item indexing requests + # should set the + # objectType field + # equal to this value. For example, if *name* is *Document*, then indexing + # requests for items of type Document should set + # objectType equal to + # *Document*. Each object definition must be uniquely named within a schema. + # The name must start with a letter and can only contain letters (A-Z, a-z) + # or numbers (0-9). + # The maximum length is 256 characters. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The options for an object. + # Corresponds to the JSON property `options` + # @return [Google::Apis::CloudsearchV1::ObjectOptions] + attr_accessor :options + + # The property definitions for the object. + # The maximum number of elements is 1000. + # Corresponds to the JSON property `propertyDefinitions` + # @return [Array] + attr_accessor :property_definitions + + 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) + @property_definitions = args[:property_definitions] if args.key?(:property_definitions) + end + end + + # The display options for an object. + class ObjectDisplayOptions + include Google::Apis::Core::Hashable + + # Defines the properties that will be displayed in the metalines of the + # search results. The property values will be displayed in the order given + # here. If a property holds multiple values, all of the values will be + # diplayed before the next properties. For this reason, it is a good practice + # to specify singular properties before repeated properties in this list. All + # of the properties must set + # is_returnable + # to true. The maximum number of elements is 3. + # Corresponds to the JSON property `metalines` + # @return [Array] + attr_accessor :metalines + + # The user friendly label to display in the search result to inidicate the + # type of the item. This is OPTIONAL; if not given, an object label will not + # be displayed on the context line of the search results. The maximum length + # is 32 characters. + # Corresponds to the JSON property `objectDisplayLabel` + # @return [String] + attr_accessor :object_display_label + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metalines = args[:metalines] if args.key?(:metalines) + @object_display_label = args[:object_display_label] if args.key?(:object_display_label) + end + end + + # The options for an object. + class ObjectOptions + include Google::Apis::Core::Hashable + + # The display options for an object. + # Corresponds to the JSON property `displayOptions` + # @return [Google::Apis::CloudsearchV1::ObjectDisplayOptions] + attr_accessor :display_options + + # Indicates which freshness property to use when adjusting search ranking for + # an item. Fresher, more recent dates indicate higher quality. Use the + # freshness option property that best works with your data. For fileshare + # documents, last modified time is most relevant. For calendar event data, + # the time when the event occurs is a more relevant freshness indicator. In + # this way, calendar events that occur closer to the time of the search query + # are considered higher quality and ranked accordingly. + # Corresponds to the JSON property `freshnessOptions` + # @return [Google::Apis::CloudsearchV1::FreshnessOptions] + attr_accessor :freshness_options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_options = args[:display_options] if args.key?(:display_options) + @freshness_options = args[:freshness_options] if args.key?(:freshness_options) + end + end + + # Options for object properties. + class ObjectPropertyOptions + include Google::Apis::Core::Hashable + + # The properties of the sub-object. These properties represent a nested + # object. For example, if this property represents a postal address, the + # subobjectProperties might be named *street*, *city*, and *state*. + # The maximum number of elements is 1000. + # Corresponds to the JSON property `subobjectProperties` + # @return [Array] + attr_accessor :subobject_properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @subobject_properties = args[:subobject_properties] if args.key?(:subobject_properties) + end + end + + # List of object values. + class ObjectValues + include Google::Apis::Core::Hashable + + # The maximum number of elements is 100. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @values = args[:values] if args.key?(:values) + 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::CloudsearchV1::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 people suggestion. + class PeopleSuggestion + include Google::Apis::Core::Hashable + + # Object to represent a person. + # Corresponds to the JSON property `person` + # @return [Google::Apis::CloudsearchV1::Person] + attr_accessor :person + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @person = args[:person] if args.key?(:person) + end + end + + # Object to represent a person. + class Person + include Google::Apis::Core::Hashable + + # The person's email addresses + # Corresponds to the JSON property `emailAddresses` + # @return [Array] + attr_accessor :email_addresses + + # The resource name of the person to provide information about. + # See + # People.get from Google People API. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Obfuscated ID of a person. + # Corresponds to the JSON property `obfuscatedId` + # @return [String] + attr_accessor :obfuscated_id + + # The person's name + # Corresponds to the JSON property `personNames` + # @return [Array] + attr_accessor :person_names + + # A person's read-only photo. A picture shown next to the person's name to + # help others recognize the person in search results. + # Corresponds to the JSON property `photos` + # @return [Array] + attr_accessor :photos + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @email_addresses = args[:email_addresses] if args.key?(:email_addresses) + @name = args[:name] if args.key?(:name) + @obfuscated_id = args[:obfuscated_id] if args.key?(:obfuscated_id) + @person_names = args[:person_names] if args.key?(:person_names) + @photos = args[:photos] if args.key?(:photos) + end + end + + # A person's photo. + class Photo + include Google::Apis::Core::Hashable + + # The URL of the photo. + # 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 + + # + class PollItemsRequest + include Google::Apis::Core::Hashable + + # Name of connector making this call. + #
Format: datasources/`source_id`/connectors/`ID` + # Corresponds to the JSON property `connectorName` + # @return [String] + attr_accessor :connector_name + + # Shared request debug options for all cloudsearch RPC methods. + # Corresponds to the JSON property `debugOptions` + # @return [Google::Apis::CloudsearchV1::DebugOptions] + attr_accessor :debug_options + + # Maximum number of items to return. + #
The maximum and the default value is 1000 + # Corresponds to the JSON property `limit` + # @return [Fixnum] + attr_accessor :limit + + # Queue name to fetch items from. If unspecified, PollItems will + # fetch from 'default' queue. + # The maximum length is 100 characters. + # Corresponds to the JSON property `queue` + # @return [String] + attr_accessor :queue + + # Limit the items polled to the ones with these statuses. + # Corresponds to the JSON property `statusCodes` + # @return [Array] + attr_accessor :status_codes + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @connector_name = args[:connector_name] if args.key?(:connector_name) + @debug_options = args[:debug_options] if args.key?(:debug_options) + @limit = args[:limit] if args.key?(:limit) + @queue = args[:queue] if args.key?(:queue) + @status_codes = args[:status_codes] if args.key?(:status_codes) + end + end + + # + class PollItemsResponse + include Google::Apis::Core::Hashable + + # Set of items from the queue available for connector to process. + #
These items have the following subset of fields populated:
+ #
version + #
metadata.hash + #
structured_data.hash + #
content.hash + #
payload + #
status + #
queue + # 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 + + # Reference to a user, group, or domain. + class Principal + include Google::Apis::Core::Hashable + + # This principal is a group identified using an external identity. + # The name field must specify the group resource name with this format: + # identitysources/`source_id`/groups/`ID` + # Corresponds to the JSON property `groupResourceName` + # @return [String] + attr_accessor :group_resource_name + + # This principal is a GSuite user, group or domain. + # Corresponds to the JSON property `gsuitePrincipal` + # @return [Google::Apis::CloudsearchV1::GSuitePrincipal] + attr_accessor :gsuite_principal + + # This principal is a user identified using an external identity. + # The name field must specify the user resource name with this format: + # identitysources/`source_id`/users/`ID` + # Corresponds to the JSON property `userResourceName` + # @return [String] + attr_accessor :user_resource_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @group_resource_name = args[:group_resource_name] if args.key?(:group_resource_name) + @gsuite_principal = args[:gsuite_principal] if args.key?(:gsuite_principal) + @user_resource_name = args[:user_resource_name] if args.key?(:user_resource_name) + end + end + + # + class ProcessingError + include Google::Apis::Core::Hashable + + # Error code indicating the nature of the error. + # Corresponds to the JSON property `code` + # @return [String] + attr_accessor :code + + # Description of the error. + # Corresponds to the JSON property `errorMessage` + # @return [String] + attr_accessor :error_message + + # In case the item fields are invalid, this field contains the details + # about the validation errors. + # Corresponds to the JSON property `fieldViolations` + # @return [Array] + attr_accessor :field_violations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @error_message = args[:error_message] if args.key?(:error_message) + @field_violations = args[:field_violations] if args.key?(:field_violations) + end + end + + # The definition of a property within an object. + class PropertyDefinition + include Google::Apis::Core::Hashable + + # Options for boolean properties. + # Corresponds to the JSON property `booleanPropertyOptions` + # @return [Google::Apis::CloudsearchV1::BooleanPropertyOptions] + attr_accessor :boolean_property_options + + # Options for date properties. + # Corresponds to the JSON property `datePropertyOptions` + # @return [Google::Apis::CloudsearchV1::DatePropertyOptions] + attr_accessor :date_property_options + + # The display options for a property. + # Corresponds to the JSON property `displayOptions` + # @return [Google::Apis::CloudsearchV1::PropertyDisplayOptions] + attr_accessor :display_options + + # Options for double properties. + # Corresponds to the JSON property `doublePropertyOptions` + # @return [Google::Apis::CloudsearchV1::DoublePropertyOptions] + attr_accessor :double_property_options + + # Options for enum properties, which allow you to define a restricted set of + # strings to match user queries, set rankings for those string values, and + # define an operator name to be paired with those strings so that users can + # narrow results to only items with a specific value. For example, for items in + # a request tracking system with priority information, you could define *p0* as + # an allowable enum value and tie this enum to the operator name *priority* so + # that search users could add *priority:p0* to their query to restrict the set + # of results to only those items indexed with the value *p0*. + # Corresponds to the JSON property `enumPropertyOptions` + # @return [Google::Apis::CloudsearchV1::EnumPropertyOptions] + attr_accessor :enum_property_options + + # Options for html properties. + # Corresponds to the JSON property `htmlPropertyOptions` + # @return [Google::Apis::CloudsearchV1::HtmlPropertyOptions] + attr_accessor :html_property_options + + # Options for integer properties. + # Corresponds to the JSON property `integerPropertyOptions` + # @return [Google::Apis::CloudsearchV1::IntegerPropertyOptions] + attr_accessor :integer_property_options + + # Indicates that the property can be used for generating facets. Cannot be + # true for properties whose type is object. IsReturnable must be true to set + # this option. + # Only supported for Boolean, Enum, and Text properties. + # Corresponds to the JSON property `isFacetable` + # @return [Boolean] + attr_accessor :is_facetable + alias_method :is_facetable?, :is_facetable + + # Indicates that multiple values are allowed for the property. For example, a + # document only has one description but can have multiple comments. Cannot be + # true for properties whose type is a boolean. + # If set to false, properties that contain more than one value will cause the + # indexing request for that item to be rejected. + # Corresponds to the JSON property `isRepeatable` + # @return [Boolean] + attr_accessor :is_repeatable + alias_method :is_repeatable?, :is_repeatable + + # Indicates that the property identifies data that should be returned in search + # results via the Query API. If set to *true*, indicates that Query API + # users can use matching property fields in results. However, storing fields + # requires more space allocation and uses more bandwidth for search queries, + # which impacts performance over large datasets. Set to *true* here only if + # the field is needed for search results. Cannot be true for properties + # whose type is an object. + # Corresponds to the JSON property `isReturnable` + # @return [Boolean] + attr_accessor :is_returnable + alias_method :is_returnable?, :is_returnable + + # Indicates that the property can be used for sorting. Cannot be true for + # properties that are repeatable. Cannot be true for properties whose type + # is object or user identifier. IsReturnable must be true to set this option. + # Only supported for Boolean, Date, Double, Integer, and Timestamp + # properties. + # Corresponds to the JSON property `isSortable` + # @return [Boolean] + attr_accessor :is_sortable + alias_method :is_sortable?, :is_sortable + + # The name of the property. Item indexing requests sent to the Indexing API + # should set the property name + # equal to this value. For example, if name is *subject_line*, then indexing + # requests for document items with subject fields should set the + # name for that field equal to + # *subject_line*. Use the name as the identifier for the object property. + # Once registered as a property for an object, you cannot re-use this name + # for another property within that object. + # The name must start with a letter and can only contain letters (A-Z, a-z) + # or numbers (0-9). + # The maximum length is 256 characters. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Options for object properties. + # Corresponds to the JSON property `objectPropertyOptions` + # @return [Google::Apis::CloudsearchV1::ObjectPropertyOptions] + attr_accessor :object_property_options + + # Options for text properties. + # Corresponds to the JSON property `textPropertyOptions` + # @return [Google::Apis::CloudsearchV1::TextPropertyOptions] + attr_accessor :text_property_options + + # Options for timestamp properties. + # Corresponds to the JSON property `timestampPropertyOptions` + # @return [Google::Apis::CloudsearchV1::TimestampPropertyOptions] + attr_accessor :timestamp_property_options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @boolean_property_options = args[:boolean_property_options] if args.key?(:boolean_property_options) + @date_property_options = args[:date_property_options] if args.key?(:date_property_options) + @display_options = args[:display_options] if args.key?(:display_options) + @double_property_options = args[:double_property_options] if args.key?(:double_property_options) + @enum_property_options = args[:enum_property_options] if args.key?(:enum_property_options) + @html_property_options = args[:html_property_options] if args.key?(:html_property_options) + @integer_property_options = args[:integer_property_options] if args.key?(:integer_property_options) + @is_facetable = args[:is_facetable] if args.key?(:is_facetable) + @is_repeatable = args[:is_repeatable] if args.key?(:is_repeatable) + @is_returnable = args[:is_returnable] if args.key?(:is_returnable) + @is_sortable = args[:is_sortable] if args.key?(:is_sortable) + @name = args[:name] if args.key?(:name) + @object_property_options = args[:object_property_options] if args.key?(:object_property_options) + @text_property_options = args[:text_property_options] if args.key?(:text_property_options) + @timestamp_property_options = args[:timestamp_property_options] if args.key?(:timestamp_property_options) + end + end + + # The display options for a property. + class PropertyDisplayOptions + include Google::Apis::Core::Hashable + + # The user friendly label for the property that will be used if the property + # is specified to be displayed in ObjectDisplayOptions. If given, the display + # label will be shown in front of the property values when the property is + # part of the object display options. For example, if the property value is + # '1', the value by itself may not be useful context for the user. If the + # display name given was 'priority', then the user will see 'priority : 1' in + # the search results which provides clear conext to search users. This is + # OPTIONAL; if not given, only the property values will be displayed. + # The maximum length is 32 characters. + # Corresponds to the JSON property `displayLabel` + # @return [String] + attr_accessor :display_label + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_label = args[:display_label] if args.key?(:display_label) + end + end + + # Represents an item to be pushed to the indexing queue. + class PushItem + include Google::Apis::Core::Hashable + + # Content hash of the item according to the repository. If specified, this is + # used to determine how to modify this + # item's status. Setting this field and the + # type field results in argument + # error. + # The maximum length is 2048 characters. + # Corresponds to the JSON property `contentHash` + # @return [String] + attr_accessor :content_hash + + # Metadata hash of the item according to the repository. If specified, this + # is used to determine how to modify this + # item's status. Setting this field and the + # type field results in argument + # error. + # The maximum length is 2048 characters. + # Corresponds to the JSON property `metadataHash` + # @return [String] + attr_accessor :metadata_hash + + # Provides additional document state information for the connector, + # such as an alternate repository ID and other metadata. + # The maximum length is 8192 bytes. + # Corresponds to the JSON property `payload` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :payload + + # Queue to which this item belongs to. The default queue is + # chosen if this field is not specified. The maximum length is + # 512 characters. + # Corresponds to the JSON property `queue` + # @return [String] + attr_accessor :queue + + # Errors when the connector is communicating to the source repository. + # Corresponds to the JSON property `repositoryError` + # @return [Google::Apis::CloudsearchV1::RepositoryError] + attr_accessor :repository_error + + # Structured data hash of the item according to the repository. If specified, + # this is used to determine how to modify this item's status. Setting this + # field and the type field + # results in argument error. + # The maximum length is 2048 characters. + # Corresponds to the JSON property `structuredDataHash` + # @return [String] + attr_accessor :structured_data_hash + + # The type of the push operation that defines the push behavior. + # 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) + @content_hash = args[:content_hash] if args.key?(:content_hash) + @metadata_hash = args[:metadata_hash] if args.key?(:metadata_hash) + @payload = args[:payload] if args.key?(:payload) + @queue = args[:queue] if args.key?(:queue) + @repository_error = args[:repository_error] if args.key?(:repository_error) + @structured_data_hash = args[:structured_data_hash] if args.key?(:structured_data_hash) + @type = args[:type] if args.key?(:type) + end + end + + # + class PushItemRequest + include Google::Apis::Core::Hashable + + # Name of connector making this call. + #
Format: datasources/`source_id`/connectors/`ID` + # Corresponds to the JSON property `connectorName` + # @return [String] + attr_accessor :connector_name + + # Shared request debug options for all cloudsearch RPC methods. + # Corresponds to the JSON property `debugOptions` + # @return [Google::Apis::CloudsearchV1::DebugOptions] + attr_accessor :debug_options + + # Represents an item to be pushed to the indexing queue. + # Corresponds to the JSON property `item` + # @return [Google::Apis::CloudsearchV1::PushItem] + attr_accessor :item + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @connector_name = args[:connector_name] if args.key?(:connector_name) + @debug_options = args[:debug_options] if args.key?(:debug_options) + @item = args[:item] if args.key?(:item) + end + end + + # + class QueryInterpretation + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `interpretationType` + # @return [String] + attr_accessor :interpretation_type + + # The interpretation of the query used in search. For example, query "email + # from john" will be interpreted as "from:john source:mail" + # Corresponds to the JSON property `interpretedQuery` + # @return [String] + attr_accessor :interpreted_query + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @interpretation_type = args[:interpretation_type] if args.key?(:interpretation_type) + @interpreted_query = args[:interpreted_query] if args.key?(:interpreted_query) + end + end + + # Options to interpret user query. + class QueryInterpretationOptions + include Google::Apis::Core::Hashable + + # Flag to disable natural language (NL) interpretation of queries. Default is + # false, Set to true to disable natural language interpretation. NL + # interpretation only applies to predefined datasources. + # Corresponds to the JSON property `disableNlInterpretation` + # @return [Boolean] + attr_accessor :disable_nl_interpretation + alias_method :disable_nl_interpretation?, :disable_nl_interpretation + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @disable_nl_interpretation = args[:disable_nl_interpretation] if args.key?(:disable_nl_interpretation) + end + end + + # Information relevant only to a query entry. + class QueryItem + include Google::Apis::Core::Hashable + + # True if the text was generated by means other than a previous user search. + # Corresponds to the JSON property `isSynthetic` + # @return [Boolean] + attr_accessor :is_synthetic + alias_method :is_synthetic?, :is_synthetic + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @is_synthetic = args[:is_synthetic] if args.key?(:is_synthetic) + end + end + + # The definition of a operator that can be used in a Search/Suggest request. + class QueryOperator + include Google::Apis::Core::Hashable + + # Display name of the operator + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Potential list of values for the opeatror field. This field is only filled + # when we can safely enumerate all the possible values of this operator. + # Corresponds to the JSON property `enumValues` + # @return [Array] + attr_accessor :enum_values + + # Indicates the operator name that can be used to isolate the property using + # the greater-than operator. + # Corresponds to the JSON property `greaterThanOperatorName` + # @return [String] + attr_accessor :greater_than_operator_name + + # Can this operator be used to get facets. + # Corresponds to the JSON property `isFacetable` + # @return [Boolean] + attr_accessor :is_facetable + alias_method :is_facetable?, :is_facetable + + # Indicates if multiple values can be set for this property. + # Corresponds to the JSON property `isRepeatable` + # @return [Boolean] + attr_accessor :is_repeatable + alias_method :is_repeatable?, :is_repeatable + + # Will the property associated with this facet be returned as part of search + # results. + # Corresponds to the JSON property `isReturnable` + # @return [Boolean] + attr_accessor :is_returnable + alias_method :is_returnable?, :is_returnable + + # Can this operator be used to sort results. + # Corresponds to the JSON property `isSortable` + # @return [Boolean] + attr_accessor :is_sortable + alias_method :is_sortable?, :is_sortable + + # Can get suggestions for this field. + # Corresponds to the JSON property `isSuggestable` + # @return [Boolean] + attr_accessor :is_suggestable + alias_method :is_suggestable?, :is_suggestable + + # Indicates the operator name that can be used to isolate the property using + # the less-than operator. + # Corresponds to the JSON property `lessThanOperatorName` + # @return [String] + attr_accessor :less_than_operator_name + + # The name of the operator. + # Corresponds to the JSON property `operatorName` + # @return [String] + attr_accessor :operator_name + + # Type of the operator. + # 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) + @display_name = args[:display_name] if args.key?(:display_name) + @enum_values = args[:enum_values] if args.key?(:enum_values) + @greater_than_operator_name = args[:greater_than_operator_name] if args.key?(:greater_than_operator_name) + @is_facetable = args[:is_facetable] if args.key?(:is_facetable) + @is_repeatable = args[:is_repeatable] if args.key?(:is_repeatable) + @is_returnable = args[:is_returnable] if args.key?(:is_returnable) + @is_sortable = args[:is_sortable] if args.key?(:is_sortable) + @is_suggestable = args[:is_suggestable] if args.key?(:is_suggestable) + @less_than_operator_name = args[:less_than_operator_name] if args.key?(:less_than_operator_name) + @operator_name = args[:operator_name] if args.key?(:operator_name) + @type = args[:type] if args.key?(:type) + end + end + + # List of sources that the user can search using the query API. + class QuerySource + include Google::Apis::Core::Hashable + + # Display name of the data source. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # List of all operators applicable for this source. + # Corresponds to the JSON property `operators` + # @return [Array] + attr_accessor :operators + + # A short name or alias for the source. This value can be used with the + # 'source' operator. + # Corresponds to the JSON property `shortName` + # @return [String] + attr_accessor :short_name + + # Defines sources for the suggest/search APIs. + # Corresponds to the JSON property `source` + # @return [Google::Apis::CloudsearchV1::Source] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @operators = args[:operators] if args.key?(:operators) + @short_name = args[:short_name] if args.key?(:short_name) + @source = args[:source] if args.key?(:source) + end + end + + # A completed query suggestion. + class QuerySuggestion + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Errors when the connector is communicating to the source repository. + class RepositoryError + include Google::Apis::Core::Hashable + + # Message that describes the error. The maximum allowable length + # of the message is 8192 characters. + # Corresponds to the JSON property `errorMessage` + # @return [String] + attr_accessor :error_message + + # Error codes. Matches the definition of HTTP status codes. + # Corresponds to the JSON property `httpStatusCode` + # @return [Fixnum] + attr_accessor :http_status_code + + # Type of error. + # 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) + @error_message = args[:error_message] if args.key?(:error_message) + @http_status_code = args[:http_status_code] if args.key?(:http_status_code) + @type = args[:type] if args.key?(:type) + end + end + + # Shared request options for all RPC methods. + class RequestOptions + include Google::Apis::Core::Hashable + + # Shared request debug options for all cloudsearch RPC methods. + # Corresponds to the JSON property `debugOptions` + # @return [Google::Apis::CloudsearchV1::DebugOptions] + attr_accessor :debug_options + + # 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. + # For translations. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Id of the application created using SearchApplicationsService. + # Corresponds to the JSON property `searchApplicationId` + # @return [String] + attr_accessor :search_application_id + + # Current user's time zone id, such as "America/Los_Angeles" or + # "Australia/Sydney". These IDs are defined by + # [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) + # project, and currently available in the file + # [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) + # 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) + @debug_options = args[:debug_options] if args.key?(:debug_options) + @language_code = args[:language_code] if args.key?(:language_code) + @search_application_id = args[:search_application_id] if args.key?(:search_application_id) + @time_zone = args[:time_zone] if args.key?(:time_zone) + end + end + + # + class ResetSearchApplicationRequest + include Google::Apis::Core::Hashable + + # Shared request debug options for all cloudsearch RPC methods. + # Corresponds to the JSON property `debugOptions` + # @return [Google::Apis::CloudsearchV1::DebugOptions] + attr_accessor :debug_options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @debug_options = args[:debug_options] if args.key?(:debug_options) + end + end + + # Debugging information about the response. + class ResponseDebugInfo + include Google::Apis::Core::Hashable + + # General debug info formatted for display. + # Corresponds to the JSON property `formattedDebugInfo` + # @return [String] + attr_accessor :formatted_debug_info + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @formatted_debug_info = args[:formatted_debug_info] if args.key?(:formatted_debug_info) + end + end + + # Information relevant only to a restrict entry. + # NextId: 7 + class RestrictItem + include Google::Apis::Core::Hashable + + # Drive follow-up search restricts (e.g. "followup:suggestions"). + # Corresponds to the JSON property `driveFollowUpRestrict` + # @return [Google::Apis::CloudsearchV1::DriveFollowUpRestrict] + attr_accessor :drive_follow_up_restrict + + # Drive location search restricts (e.g. "is:starred"). + # Corresponds to the JSON property `driveLocationRestrict` + # @return [Google::Apis::CloudsearchV1::DriveLocationRestrict] + attr_accessor :drive_location_restrict + + # Drive mime-type search restricts (e.g. "type:pdf"). + # Corresponds to the JSON property `driveMimeTypeRestrict` + # @return [Google::Apis::CloudsearchV1::DriveMimeTypeRestrict] + attr_accessor :drive_mime_type_restrict + + # The time span search restrict (e.g. "after:2017-09-11 before:2017-09-12"). + # Corresponds to the JSON property `driveTimeSpanRestrict` + # @return [Google::Apis::CloudsearchV1::DriveTimeSpanRestrict] + attr_accessor :drive_time_span_restrict + + # The search restrict (e.g. "after:2017-09-11 before:2017-09-12"). + # Corresponds to the JSON property `searchOperator` + # @return [String] + attr_accessor :search_operator + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @drive_follow_up_restrict = args[:drive_follow_up_restrict] if args.key?(:drive_follow_up_restrict) + @drive_location_restrict = args[:drive_location_restrict] if args.key?(:drive_location_restrict) + @drive_mime_type_restrict = args[:drive_mime_type_restrict] if args.key?(:drive_mime_type_restrict) + @drive_time_span_restrict = args[:drive_time_span_restrict] if args.key?(:drive_time_span_restrict) + @search_operator = args[:search_operator] if args.key?(:search_operator) + end + end + + # Result count information + class ResultCounts + include Google::Apis::Core::Hashable + + # Result count information for each source with results. + # Corresponds to the JSON property `sourceResultCounts` + # @return [Array] + attr_accessor :source_result_counts + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @source_result_counts = args[:source_result_counts] if args.key?(:source_result_counts) + end + end + + # Debugging information about the result. + class ResultDebugInfo + include Google::Apis::Core::Hashable + + # General debug info formatted for display. + # Corresponds to the JSON property `formattedDebugInfo` + # @return [String] + attr_accessor :formatted_debug_info + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @formatted_debug_info = args[:formatted_debug_info] if args.key?(:formatted_debug_info) + end + end + + # Display Fields for Search Results + class ResultDisplayField + include Google::Apis::Core::Hashable + + # The display label for the property. + # Corresponds to the JSON property `label` + # @return [String] + attr_accessor :label + + # The operator name of the property. + # Corresponds to the JSON property `operatorName` + # @return [String] + attr_accessor :operator_name + + # A typed name-value pair for structured data. The type of the value should + # be the same as the registered type for the `name` property in the object + # definition of `objectType`. + # Corresponds to the JSON property `property` + # @return [Google::Apis::CloudsearchV1::NamedProperty] + attr_accessor :property + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @label = args[:label] if args.key?(:label) + @operator_name = args[:operator_name] if args.key?(:operator_name) + @property = args[:property] if args.key?(:property) + end + end + + # The collection of fields that make up a displayed line + class ResultDisplayLine + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `fields` + # @return [Array] + attr_accessor :fields + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fields = args[:fields] if args.key?(:fields) + end + end + + # + class ResultDisplayMetadata + include Google::Apis::Core::Hashable + + # The metalines content to be displayed with the result. + # Corresponds to the JSON property `metalines` + # @return [Array] + attr_accessor :metalines + + # The display label for the object. + # Corresponds to the JSON property `objectTypeLabel` + # @return [String] + attr_accessor :object_type_label + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metalines = args[:metalines] if args.key?(:metalines) + @object_type_label = args[:object_type_label] if args.key?(:object_type_label) + end + end + + # + class RetrievalImportance + include Google::Apis::Core::Hashable + + # Indicates the ranking importance given to property when it is matched + # during retrieval. Once set, the token importance of a property cannot be + # changed. + # Corresponds to the JSON property `importance` + # @return [String] + attr_accessor :importance + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @importance = args[:importance] if args.key?(:importance) + end + end + + # The schema definition for a data source. + class Schema + include Google::Apis::Core::Hashable + + # The list of top-level objects for the data source. + # The maximum number of elements is 10. + # Corresponds to the JSON property `objectDefinitions` + # @return [Array] + attr_accessor :object_definitions + + # IDs of the Long Running Operations (LROs) currently running for this + # schema. After modifying the schema, wait for opeations to complete + # before indexing additional content. + # Corresponds to the JSON property `operationIds` + # @return [Array] + attr_accessor :operation_ids + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @object_definitions = args[:object_definitions] if args.key?(:object_definitions) + @operation_ids = args[:operation_ids] if args.key?(:operation_ids) + end + end + + # Scoring configurations for a source while processing a + # Search or + # Suggest request. + class ScoringConfig + include Google::Apis::Core::Hashable + + # Whether to use freshness as a ranking signal. By default, freshness is used + # as a ranking signal. + # Corresponds to the JSON property `disableFreshness` + # @return [Boolean] + attr_accessor :disable_freshness + alias_method :disable_freshness?, :disable_freshness + + # Whether to personalize the results. By default, personal signals will + # be used to boost results. + # Corresponds to the JSON property `disablePersonalization` + # @return [Boolean] + attr_accessor :disable_personalization + alias_method :disable_personalization?, :disable_personalization + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @disable_freshness = args[:disable_freshness] if args.key?(:disable_freshness) + @disable_personalization = args[:disable_personalization] if args.key?(:disable_personalization) + end + end + + # SearchApplication + class SearchApplication + include Google::Apis::Core::Hashable + + # Retrictions applied to the configurations. + # The maximum number of elements is 10. + # Corresponds to the JSON property `dataSourceRestrictions` + # @return [Array] + attr_accessor :data_source_restrictions + + # The default fields for returning facet results. + # The sources specified here also have been included in + # data_source_restrictions + # above. + # Corresponds to the JSON property `defaultFacetOptions` + # @return [Array] + attr_accessor :default_facet_options + + # The default options for sorting the search results + # Corresponds to the JSON property `defaultSortOptions` + # @return [Google::Apis::CloudsearchV1::SortOptions] + attr_accessor :default_sort_options + + # Display name of the Search Application. + # The maximum length is 300 characters. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Name of the Search Application. + #
Format: searchapplications/`application_id`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # IDs of the Long Running Operations (LROs) currently running for this schema. + # Output only field. + # Corresponds to the JSON property `operationIds` + # @return [Array] + attr_accessor :operation_ids + + # Scoring configurations for a source while processing a + # Search or + # Suggest request. + # Corresponds to the JSON property `scoringConfig` + # @return [Google::Apis::CloudsearchV1::ScoringConfig] + attr_accessor :scoring_config + + # Configuration for a sources specified in data_source_restrictions. + # Corresponds to the JSON property `sourceConfig` + # @return [Array] + attr_accessor :source_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @data_source_restrictions = args[:data_source_restrictions] if args.key?(:data_source_restrictions) + @default_facet_options = args[:default_facet_options] if args.key?(:default_facet_options) + @default_sort_options = args[:default_sort_options] if args.key?(:default_sort_options) + @display_name = args[:display_name] if args.key?(:display_name) + @name = args[:name] if args.key?(:name) + @operation_ids = args[:operation_ids] if args.key?(:operation_ids) + @scoring_config = args[:scoring_config] if args.key?(:scoring_config) + @source_config = args[:source_config] if args.key?(:source_config) + end + end + + # Additional search quality metadata of the item. + class SearchQualityMetadata + include Google::Apis::Core::Hashable + + # An indication of the quality of the item, used to influence search quality. + # Value should be between 0.0 (lowest quality) and 1.0 (highest quality). + # Corresponds to the JSON property `quality` + # @return [Float] + attr_accessor :quality + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @quality = args[:quality] if args.key?(:quality) + end + end + + # The search API request. + class SearchRequest + include Google::Apis::Core::Hashable + + # The sources to use for querying. If not specified, all data sources + # from the current search application are used. + # Corresponds to the JSON property `dataSourceRestrictions` + # @return [Array] + attr_accessor :data_source_restrictions + + # + # Corresponds to the JSON property `facetOptions` + # @return [Array] + attr_accessor :facet_options + + # Maximum number of search results to return in one page. + # Valid values are between 1 and 100, inclusive. + # Default value is 10. + # Corresponds to the JSON property `pageSize` + # @return [Fixnum] + attr_accessor :page_size + + # The raw query string. + # See supported search operators in the [Cloud search + # Cheat + # Sheet](https://gsuite.google.com/learning-center/products/cloudsearch/cheat- + # sheet/) + # Corresponds to the JSON property `query` + # @return [String] + attr_accessor :query + + # Options to interpret user query. + # Corresponds to the JSON property `queryInterpretationOptions` + # @return [Google::Apis::CloudsearchV1::QueryInterpretationOptions] + attr_accessor :query_interpretation_options + + # Shared request options for all RPC methods. + # Corresponds to the JSON property `requestOptions` + # @return [Google::Apis::CloudsearchV1::RequestOptions] + attr_accessor :request_options + + # The options for sorting the search results + # Corresponds to the JSON property `sortOptions` + # @return [Google::Apis::CloudsearchV1::SortOptions] + attr_accessor :sort_options + + # Starting index of the results. + # Corresponds to the JSON property `start` + # @return [Fixnum] + attr_accessor :start + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @data_source_restrictions = args[:data_source_restrictions] if args.key?(:data_source_restrictions) + @facet_options = args[:facet_options] if args.key?(:facet_options) + @page_size = args[:page_size] if args.key?(:page_size) + @query = args[:query] if args.key?(:query) + @query_interpretation_options = args[:query_interpretation_options] if args.key?(:query_interpretation_options) + @request_options = args[:request_options] if args.key?(:request_options) + @sort_options = args[:sort_options] if args.key?(:sort_options) + @start = args[:start] if args.key?(:start) + end + end + + # The search API response. + class SearchResponse + include Google::Apis::Core::Hashable + + # Debugging information about the response. + # Corresponds to the JSON property `debugInfo` + # @return [Google::Apis::CloudsearchV1::ResponseDebugInfo] + attr_accessor :debug_info + + # Error information about the response. + # Corresponds to the JSON property `errorInfo` + # @return [Google::Apis::CloudsearchV1::ErrorInfo] + attr_accessor :error_info + + # Repeated facet results. + # Corresponds to the JSON property `facetResults` + # @return [Array] + attr_accessor :facet_results + + # Whether there are more search results matching the query. + # Corresponds to the JSON property `hasMoreResults` + # @return [Boolean] + attr_accessor :has_more_results + alias_method :has_more_results?, :has_more_results + + # Query interpretation result for user query. Empty if query interpretation + # is disabled. + # Corresponds to the JSON property `queryInterpretation` + # @return [Google::Apis::CloudsearchV1::QueryInterpretation] + attr_accessor :query_interpretation + + # The estimated result count for this query. + # Corresponds to the JSON property `resultCountEstimate` + # @return [Fixnum] + attr_accessor :result_count_estimate + + # The exact result count for this query. + # Corresponds to the JSON property `resultCountExact` + # @return [Fixnum] + attr_accessor :result_count_exact + + # Result count information + # Corresponds to the JSON property `resultCounts` + # @return [Google::Apis::CloudsearchV1::ResultCounts] + attr_accessor :result_counts + + # Results from a search query. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + # Suggested spelling for the query. + # Corresponds to the JSON property `spellResults` + # @return [Array] + attr_accessor :spell_results + + # Structured results for the user query. These results are not counted + # against the page_size. + # Corresponds to the JSON property `structuredResults` + # @return [Array] + attr_accessor :structured_results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @debug_info = args[:debug_info] if args.key?(:debug_info) + @error_info = args[:error_info] if args.key?(:error_info) + @facet_results = args[:facet_results] if args.key?(:facet_results) + @has_more_results = args[:has_more_results] if args.key?(:has_more_results) + @query_interpretation = args[:query_interpretation] if args.key?(:query_interpretation) + @result_count_estimate = args[:result_count_estimate] if args.key?(:result_count_estimate) + @result_count_exact = args[:result_count_exact] if args.key?(:result_count_exact) + @result_counts = args[:result_counts] if args.key?(:result_counts) + @results = args[:results] if args.key?(:results) + @spell_results = args[:spell_results] if args.key?(:spell_results) + @structured_results = args[:structured_results] if args.key?(:structured_results) + end + end + + # Results containing indexed information for a document. + class SearchResult + include Google::Apis::Core::Hashable + + # If source is clustered, provide list of clustered results. There will only + # be one level of clustered results. If current source is not enabled for + # clustering, this field will be empty. + # Corresponds to the JSON property `clusteredResults` + # @return [Array] + attr_accessor :clustered_results + + # Debugging information about the result. + # Corresponds to the JSON property `debugInfo` + # @return [Google::Apis::CloudsearchV1::ResultDebugInfo] + attr_accessor :debug_info + + # Metadata of a matched search result. + # Corresponds to the JSON property `metadata` + # @return [Google::Apis::CloudsearchV1::Metadata] + attr_accessor :metadata + + # Snippet of the search result, which summarizes the content of the resulting + # page. + # Corresponds to the JSON property `snippet` + # @return [Google::Apis::CloudsearchV1::Snippet] + attr_accessor :snippet + + # Title of the search result. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # The URL of the result. + # 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) + @clustered_results = args[:clustered_results] if args.key?(:clustered_results) + @debug_info = args[:debug_info] if args.key?(:debug_info) + @metadata = args[:metadata] if args.key?(:metadata) + @snippet = args[:snippet] if args.key?(:snippet) + @title = args[:title] if args.key?(:title) + @url = args[:url] if args.key?(:url) + end + end + + # Snippet of the search result, which summarizes the content of the resulting + # page. + class Snippet + include Google::Apis::Core::Hashable + + # The matched ranges in the snippet. + # Corresponds to the JSON property `matchRanges` + # @return [Array] + attr_accessor :match_ranges + + # The snippet of the document. + # The snippet of the document. May contain escaped HTML character that + # should be unescaped prior to rendering. + # Corresponds to the JSON property `snippet` + # @return [String] + attr_accessor :snippet + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @match_ranges = args[:match_ranges] if args.key?(:match_ranges) + @snippet = args[:snippet] if args.key?(:snippet) + end + end + + # + class SortOptions + include Google::Apis::Core::Hashable + + # Name of the operator corresponding to the field to sort on. + # The corresponding property must be marked as + # sortable. + # Corresponds to the JSON property `operatorName` + # @return [String] + attr_accessor :operator_name + + # Ascending is the default sort order + # 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) + @operator_name = args[:operator_name] if args.key?(:operator_name) + @sort_order = args[:sort_order] if args.key?(:sort_order) + end + end + + # Defines sources for the suggest/search APIs. + class Source + include Google::Apis::Core::Hashable + + # Source name for content indexed by the + # Indexing API. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Predefined content source for Google Apps. + # Corresponds to the JSON property `predefinedSource` + # @return [String] + attr_accessor :predefined_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @predefined_source = args[:predefined_source] if args.key?(:predefined_source) + end + end + + # Configurations for a source while processing a + # Search or + # Suggest request. + class SourceConfig + include Google::Apis::Core::Hashable + + # Set search results crowding limits. Crowding is a situation in which + # multiple results from the same source or host "crowd out" other results, + # diminishing the quality of search for users. To foster better search quality + # and source diversity in search results, you can set a condition to reduce + # repetitive results by source. + # Corresponds to the JSON property `crowdingConfig` + # @return [Google::Apis::CloudsearchV1::SourceCrowdingConfig] + attr_accessor :crowding_config + + # Set the scoring configuration. This allows modifying the ranking of results + # for a source. + # Corresponds to the JSON property `scoringConfig` + # @return [Google::Apis::CloudsearchV1::SourceScoringConfig] + attr_accessor :scoring_config + + # Defines sources for the suggest/search APIs. + # Corresponds to the JSON property `source` + # @return [Google::Apis::CloudsearchV1::Source] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @crowding_config = args[:crowding_config] if args.key?(:crowding_config) + @scoring_config = args[:scoring_config] if args.key?(:scoring_config) + @source = args[:source] if args.key?(:source) + end + end + + # Set search results crowding limits. Crowding is a situation in which + # multiple results from the same source or host "crowd out" other results, + # diminishing the quality of search for users. To foster better search quality + # and source diversity in search results, you can set a condition to reduce + # repetitive results by source. + class SourceCrowdingConfig + include Google::Apis::Core::Hashable + + # Use a field to control results crowding. For example, if you want to + # control overly similar results from Gmail topics, use `thread_id`. + # For similar pages from Google Sites, you can use `webspace_id`. + # When matching query results contain the same field value in + # `GenericMetadata`, crowding limits are set on those records. + # Corresponds to the JSON property `field` + # @return [String] + attr_accessor :field + + # Maximum number of results allowed from a source. + # No limits will be set on results if this value is less than or equal to 0. + # Corresponds to the JSON property `numResults` + # @return [Fixnum] + attr_accessor :num_results + + # Maximum number of suggestions allowed from a source. + # No limits will be set on results if this value is less than or equal to 0. + # Corresponds to the JSON property `numSuggestions` + # @return [Fixnum] + attr_accessor :num_suggestions + + # Control results by content source. This option limits the total number + # of results from a given source and ignores field-based crowding control. + # Corresponds to the JSON property `source` + # @return [Boolean] + attr_accessor :source + alias_method :source?, :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @field = args[:field] if args.key?(:field) + @num_results = args[:num_results] if args.key?(:num_results) + @num_suggestions = args[:num_suggestions] if args.key?(:num_suggestions) + @source = args[:source] if args.key?(:source) + end + end + + # Per source result count information. + class SourceResultCount + include Google::Apis::Core::Hashable + + # Whether there are more search results for this source. + # Corresponds to the JSON property `hasMoreResults` + # @return [Boolean] + attr_accessor :has_more_results + alias_method :has_more_results?, :has_more_results + + # The estimated result count for this source. + # Corresponds to the JSON property `resultCountEstimate` + # @return [Fixnum] + attr_accessor :result_count_estimate + + # The exact result count for this source. + # Corresponds to the JSON property `resultCountExact` + # @return [Fixnum] + attr_accessor :result_count_exact + + # Defines sources for the suggest/search APIs. + # Corresponds to the JSON property `source` + # @return [Google::Apis::CloudsearchV1::Source] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @has_more_results = args[:has_more_results] if args.key?(:has_more_results) + @result_count_estimate = args[:result_count_estimate] if args.key?(:result_count_estimate) + @result_count_exact = args[:result_count_exact] if args.key?(:result_count_exact) + @source = args[:source] if args.key?(:source) + end + end + + # Set the scoring configuration. This allows modifying the ranking of results + # for a source. + class SourceScoringConfig + include Google::Apis::Core::Hashable + + # Importance of the source. + # Corresponds to the JSON property `sourceImportance` + # @return [String] + attr_accessor :source_importance + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @source_importance = args[:source_importance] if args.key?(:source_importance) + end + end + + # + class SpellResult + include Google::Apis::Core::Hashable + + # The suggested spelling of the query. + # Corresponds to the JSON property `suggestedQuery` + # @return [String] + attr_accessor :suggested_query + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @suggested_query = args[:suggested_query] if args.key?(:suggested_query) + end + end + + # Start upload file request. + class StartUploadItemRequest + include Google::Apis::Core::Hashable + + # Name of connector making this call. + #
Format: datasources/`source_id`/connectors/`ID` + # Corresponds to the JSON property `connectorName` + # @return [String] + attr_accessor :connector_name + + # Shared request debug options for all cloudsearch RPC methods. + # Corresponds to the JSON property `debugOptions` + # @return [Google::Apis::CloudsearchV1::DebugOptions] + attr_accessor :debug_options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @connector_name = args[:connector_name] if args.key?(:connector_name) + @debug_options = args[:debug_options] if args.key?(:debug_options) + 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 + + # A structured data object consisting of named properties. + class StructuredDataObject + include Google::Apis::Core::Hashable + + # The properties for the object. + # The maximum number of elements is 1000. + # Corresponds to the JSON property `properties` + # @return [Array] + attr_accessor :properties + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @properties = args[:properties] if args.key?(:properties) + end + end + + # Structured results that are returned as part of search request. + class StructuredResult + include Google::Apis::Core::Hashable + + # Object to represent a person. + # Corresponds to the JSON property `person` + # @return [Google::Apis::CloudsearchV1::Person] + attr_accessor :person + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @person = args[:person] if args.key?(:person) + end + end + + # Request of suggest API. + class SuggestRequest + include Google::Apis::Core::Hashable + + # The sources to use for suggestions. If not specified, all data sources + # from the current search application are used. + # Corresponds to the JSON property `dataSourceRestrictions` + # @return [Array] + attr_accessor :data_source_restrictions + + # Partial query for the completion suggestion. + # Corresponds to the JSON property `query` + # @return [String] + attr_accessor :query + + # Shared request options for all RPC methods. + # Corresponds to the JSON property `requestOptions` + # @return [Google::Apis::CloudsearchV1::RequestOptions] + attr_accessor :request_options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @data_source_restrictions = args[:data_source_restrictions] if args.key?(:data_source_restrictions) + @query = args[:query] if args.key?(:query) + @request_options = args[:request_options] if args.key?(:request_options) + end + end + + # Response of the suggest API. + class SuggestResponse + include Google::Apis::Core::Hashable + + # List of suggestion results. + # Corresponds to the JSON property `suggestResults` + # @return [Array] + attr_accessor :suggest_results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @suggest_results = args[:suggest_results] if args.key?(:suggest_results) + end + end + + # One suggestion result. + class SuggestResult + include Google::Apis::Core::Hashable + + # A people suggestion. + # Corresponds to the JSON property `peopleSuggestion` + # @return [Google::Apis::CloudsearchV1::PeopleSuggestion] + attr_accessor :people_suggestion + + # A completed query suggestion. + # Corresponds to the JSON property `querySuggestion` + # @return [Google::Apis::CloudsearchV1::QuerySuggestion] + attr_accessor :query_suggestion + + # Defines sources for the suggest/search APIs. + # Corresponds to the JSON property `source` + # @return [Google::Apis::CloudsearchV1::Source] + attr_accessor :source + + # The suggested query that will be used for search, when the user + # clicks on the suggestion + # Corresponds to the JSON property `suggestedQuery` + # @return [String] + attr_accessor :suggested_query + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @people_suggestion = args[:people_suggestion] if args.key?(:people_suggestion) + @query_suggestion = args[:query_suggestion] if args.key?(:query_suggestion) + @source = args[:source] if args.key?(:source) + @suggested_query = args[:suggested_query] if args.key?(:suggested_query) + end + end + + # Used to provide a search operator for text properties. This is optional. + # Search operators let users restrict the query to specific fields relevant + # to the type of item being searched. + class TextOperatorOptions + include Google::Apis::Core::Hashable + + # If true, the text value will be tokenized as one atomic value in + # operator searches and facet matches. For example, if the operator name is + # "genre" and the value is "science-fiction" the query restrictions + # "genre:science" and "genre:fiction" will not match the item; + # "genre:science-fiction" will. Value matching is case-sensitive + # and does not remove special characters. + # If false, the text will be tokenized. For example, if the value is + # "science-fiction" the queries "genre:science" and "genre:fiction" will + # match the item. + # Corresponds to the JSON property `exactMatchWithOperator` + # @return [Boolean] + attr_accessor :exact_match_with_operator + alias_method :exact_match_with_operator?, :exact_match_with_operator + + # Indicates the operator name required in the query in order to isolate the + # text property. For example, if operatorName is *subject* and the + # property's name is *subjectLine*, then queries like + # *subject:<value>* will show results only where the value of the + # property named *subjectLine* matches *<value>*. By contrast, a + # search that uses the same *<value>* without an operator will return + # all items where *<value>* matches the value of any + # text properties or text within the content field for the item. + # The operator name can only contain lowercase letters (a-z). + # The maximum length is 32 characters. + # Corresponds to the JSON property `operatorName` + # @return [String] + attr_accessor :operator_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @exact_match_with_operator = args[:exact_match_with_operator] if args.key?(:exact_match_with_operator) + @operator_name = args[:operator_name] if args.key?(:operator_name) + end + end + + # Options for text properties. + class TextPropertyOptions + include Google::Apis::Core::Hashable + + # Used to provide a search operator for text properties. This is optional. + # Search operators let users restrict the query to specific fields relevant + # to the type of item being searched. + # Corresponds to the JSON property `operatorOptions` + # @return [Google::Apis::CloudsearchV1::TextOperatorOptions] + attr_accessor :operator_options + + # Indicates the search quality importance of the tokens within the + # field when used for retrieval. + # Corresponds to the JSON property `retrievalImportance` + # @return [Google::Apis::CloudsearchV1::RetrievalImportance] + attr_accessor :retrieval_importance + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operator_options = args[:operator_options] if args.key?(:operator_options) + @retrieval_importance = args[:retrieval_importance] if args.key?(:retrieval_importance) + end + end + + # List of text values. + class TextValues + include Google::Apis::Core::Hashable + + # The maximum allowable length for text values is 2048 characters. + # The maximum number of string elements is 100. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @values = args[:values] if args.key?(:values) + end + end + + # Used to provide a search operator for timestamp properties. This is + # optional. Search operators let users restrict the query to specific fields + # relevant to the type of item being searched. + class TimestampOperatorOptions + include Google::Apis::Core::Hashable + + # Indicates the operator name required in the query in order to isolate the + # timestamp property using the greater-than operator. For example, if + # greaterThanOperatorName is *closedafter* and the property's name is + # *closeDate*, then queries like *closedafter:<value>* will + # show results only where the value of the property named *closeDate* is + # later than *<value>*. + # The operator name can only contain lowercase letters (a-z). + # The maximum length is 32 characters. + # Corresponds to the JSON property `greaterThanOperatorName` + # @return [String] + attr_accessor :greater_than_operator_name + + # Indicates the operator name required in the query in order to isolate the + # timestamp property using the less-than operator. For example, if + # lessThanOperatorName is *closedbefore* and the property's name is + # *closeDate*, then queries like *closedbefore:<value>* will + # show results only where the value of the property named *closeDate* is + # earlier than *<value>*. + # The operator name can only contain lowercase letters (a-z). + # The maximum length is 32 characters. + # Corresponds to the JSON property `lessThanOperatorName` + # @return [String] + attr_accessor :less_than_operator_name + + # Indicates the operator name required in the query in order to isolate the + # timestamp property. For example, if operatorName is *closedon* and the + # property's name is *closeDate*, then queries like + # *closedon:<value>* will show results only where the value of the + # property named *closeDate* matches *<value>*. By contrast, a + # search that uses the same *<value>* without an operator will return + # all items where *<value>* matches the value of any String + # properties or text within the content field for the item. The operator + # name can only contain lowercase letters (a-z). The maximum length is 32 + # characters. + # Corresponds to the JSON property `operatorName` + # @return [String] + attr_accessor :operator_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @greater_than_operator_name = args[:greater_than_operator_name] if args.key?(:greater_than_operator_name) + @less_than_operator_name = args[:less_than_operator_name] if args.key?(:less_than_operator_name) + @operator_name = args[:operator_name] if args.key?(:operator_name) + end + end + + # Options for timestamp properties. + class TimestampPropertyOptions + include Google::Apis::Core::Hashable + + # Used to provide a search operator for timestamp properties. This is + # optional. Search operators let users restrict the query to specific fields + # relevant to the type of item being searched. + # Corresponds to the JSON property `operatorOptions` + # @return [Google::Apis::CloudsearchV1::TimestampOperatorOptions] + attr_accessor :operator_options + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operator_options = args[:operator_options] if args.key?(:operator_options) + end + end + + # List of timestamp values. + class TimestampValues + include Google::Apis::Core::Hashable + + # The maximum number of elements is 100. + # Corresponds to the JSON property `values` + # @return [Array] + attr_accessor :values + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @values = args[:values] if args.key?(:values) + end + end + + # + class UnmappedIdentity + include Google::Apis::Core::Hashable + + # Reference to a user, group, or domain. + # Corresponds to the JSON property `externalIdentity` + # @return [Google::Apis::CloudsearchV1::Principal] + attr_accessor :external_identity + + # The resolution status for the external identity. + # Corresponds to the JSON property `resolutionStatusCode` + # @return [String] + attr_accessor :resolution_status_code + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @external_identity = args[:external_identity] if args.key?(:external_identity) + @resolution_status_code = args[:resolution_status_code] if args.key?(:resolution_status_code) + end + end + + # + class UnreserveItemsRequest + include Google::Apis::Core::Hashable + + # Name of connector making this call. + #
Format: datasources/`source_id`/connectors/`ID` + # Corresponds to the JSON property `connectorName` + # @return [String] + attr_accessor :connector_name + + # Shared request debug options for all cloudsearch RPC methods. + # Corresponds to the JSON property `debugOptions` + # @return [Google::Apis::CloudsearchV1::DebugOptions] + attr_accessor :debug_options + + # Name of a queue to unreserve items from. + # Corresponds to the JSON property `queue` + # @return [String] + attr_accessor :queue + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @connector_name = args[:connector_name] if args.key?(:connector_name) + @debug_options = args[:debug_options] if args.key?(:debug_options) + @queue = args[:queue] if args.key?(:queue) + end + end + + # + class UpdateDataSourceRequest + include Google::Apis::Core::Hashable + + # Shared request debug options for all cloudsearch RPC methods. + # Corresponds to the JSON property `debugOptions` + # @return [Google::Apis::CloudsearchV1::DebugOptions] + attr_accessor :debug_options + + # Data source is a logical namespace for items to be indexed. + # All items must belong to a data source. This is the prerequisite before + # items can be indexed into Cloud Search. + # Corresponds to the JSON property `source` + # @return [Google::Apis::CloudsearchV1::DataSource] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @debug_options = args[:debug_options] if args.key?(:debug_options) + @source = args[:source] if args.key?(:source) + end + end + + # + class UpdateSchemaRequest + include Google::Apis::Core::Hashable + + # Shared request debug options for all cloudsearch RPC methods. + # Corresponds to the JSON property `debugOptions` + # @return [Google::Apis::CloudsearchV1::DebugOptions] + attr_accessor :debug_options + + # The schema definition for a data source. + # Corresponds to the JSON property `schema` + # @return [Google::Apis::CloudsearchV1::Schema] + attr_accessor :schema + + # If true, the request will be validated without side effects. + # Corresponds to the JSON property `validateOnly` + # @return [Boolean] + attr_accessor :validate_only + alias_method :validate_only?, :validate_only + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @debug_options = args[:debug_options] if args.key?(:debug_options) + @schema = args[:schema] if args.key?(:schema) + @validate_only = args[:validate_only] if args.key?(:validate_only) + end + end + + # Represents an upload session reference. + # This reference is created via upload + # method. + # Updating of item content may refer to this uploaded content via + # contentDataRef. + class UploadItemRef + include Google::Apis::Core::Hashable + + # Name of the content reference. + # The maximum length is 2048 characters. + # 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) + @name = args[:name] if args.key?(:name) + end + end + + # Definition of a single value with generic type. + class Value + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `booleanValue` + # @return [Boolean] + attr_accessor :boolean_value + alias_method :boolean_value?, :boolean_value + + # Represents a whole calendar date, for example a date of birth. The time of day + # and time zone are either specified elsewhere or are not significant. The date + # is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/ + # wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date + # between the year 1 and 9999. + # Corresponds to the JSON property `dateValue` + # @return [Google::Apis::CloudsearchV1::Date] + attr_accessor :date_value + + # + # Corresponds to the JSON property `doubleValue` + # @return [Float] + attr_accessor :double_value + + # + # Corresponds to the JSON property `integerValue` + # @return [Fixnum] + attr_accessor :integer_value + + # + # Corresponds to the JSON property `stringValue` + # @return [String] + attr_accessor :string_value + + # + # Corresponds to the JSON property `timestampValue` + # @return [String] + attr_accessor :timestamp_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @boolean_value = args[:boolean_value] if args.key?(:boolean_value) + @date_value = args[:date_value] if args.key?(:date_value) + @double_value = args[:double_value] if args.key?(:double_value) + @integer_value = args[:integer_value] if args.key?(:integer_value) + @string_value = args[:string_value] if args.key?(:string_value) + @timestamp_value = args[:timestamp_value] if args.key?(:timestamp_value) + end + end + + # + class ValueFilter + include Google::Apis::Core::Hashable + + # The `operator_name` applied to the query, such as *price_greater_than*. + # The filter can work against both types of filters defined in the schema + # for your data source: + #

+ # 1. `operator_name`, where the query filters results by the property + # that matches the value. + #
+ # 2. `greater_than_operator_name` or `less_than_operator_name` in your + # schema. The query filters the results for the property values that are + # greater than or less than the supplied value in the query. + # Corresponds to the JSON property `operatorName` + # @return [String] + attr_accessor :operator_name + + # Definition of a single value with generic type. + # Corresponds to the JSON property `value` + # @return [Google::Apis::CloudsearchV1::Value] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @operator_name = args[:operator_name] if args.key?(:operator_name) + @value = args[:value] if args.key?(:value) + end + end + end + end +end diff --git a/generated/google/apis/cloudsearch_v1/representations.rb b/generated/google/apis/cloudsearch_v1/representations.rb new file mode 100644 index 000000000..1d8aa87d2 --- /dev/null +++ b/generated/google/apis/cloudsearch_v1/representations.rb @@ -0,0 +1,2151 @@ +# 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 CloudsearchV1 + + class BooleanOperatorOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BooleanPropertyOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CompositeFilter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomerIndexStats + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DataSource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DataSourceIndexStats + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DataSourceRestriction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Date + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DateOperatorOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DatePropertyOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DateValues + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DebugOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DeleteQueueItemsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DisplayedProperty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DoubleOperatorOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DoublePropertyOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DoubleValues + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DriveFollowUpRestrict + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DriveLocationRestrict + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DriveMimeTypeRestrict + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DriveTimeSpanRestrict + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EmailAddress + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EnumOperatorOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EnumPropertyOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EnumValuePair + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class EnumValues + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ErrorInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ErrorMessage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FacetBucket + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FacetOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FacetResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FieldViolation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Filter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FilterOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FreshnessOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GSuitePrincipal + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GetCustomerIndexStatsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GetDataSourceIndexStatsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class HtmlOperatorOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class HtmlPropertyOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class HtmlValues + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IndexItemRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntegerOperatorOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntegerPropertyOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class IntegerValues + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Interaction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Item + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ItemAcl + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ItemContent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ItemCountByStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ItemMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ItemStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ItemStructuredData + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListDataSourceResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListItemNamesForUnmappedIdentityResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListItemsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListQuerySourcesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListSearchApplicationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListUnmappedIdentitiesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MatchRange + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Media + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Metadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Metaline + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Name + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class NamedProperty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ObjectDefinition + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ObjectDisplayOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ObjectOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ObjectPropertyOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ObjectValues + 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 PeopleSuggestion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Person + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Photo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PollItemsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PollItemsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Principal + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ProcessingError + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PropertyDefinition + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PropertyDisplayOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PushItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PushItemRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class QueryInterpretation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class QueryInterpretationOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class QueryItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class QueryOperator + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class QuerySource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class QuerySuggestion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RepositoryError + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RequestOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResetSearchApplicationRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResponseDebugInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RestrictItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResultCounts + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResultDebugInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResultDisplayField + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResultDisplayLine + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ResultDisplayMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RetrievalImportance + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Schema + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ScoringConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SearchApplication + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SearchQualityMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SearchRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SearchResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SearchResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Snippet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SortOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Source + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SourceConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SourceCrowdingConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SourceResultCount + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SourceScoringConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SpellResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class StartUploadItemRequest + 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 StructuredDataObject + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class StructuredResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SuggestRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SuggestResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class SuggestResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TextOperatorOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TextPropertyOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TextValues + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TimestampOperatorOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TimestampPropertyOptions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TimestampValues + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UnmappedIdentity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UnreserveItemsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpdateDataSourceRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpdateSchemaRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UploadItemRef + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Value + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ValueFilter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class BooleanOperatorOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operator_name, as: 'operatorName' + end + end + + class BooleanPropertyOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operator_options, as: 'operatorOptions', class: Google::Apis::CloudsearchV1::BooleanOperatorOptions, decorator: Google::Apis::CloudsearchV1::BooleanOperatorOptions::Representation + + end + end + + class CompositeFilter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :logic_operator, as: 'logicOperator' + collection :sub_filters, as: 'subFilters', class: Google::Apis::CloudsearchV1::Filter, decorator: Google::Apis::CloudsearchV1::Filter::Representation + + end + end + + class CustomerIndexStats + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :date, as: 'date', class: Google::Apis::CloudsearchV1::Date, decorator: Google::Apis::CloudsearchV1::Date::Representation + + collection :item_count_by_status, as: 'itemCountByStatus', class: Google::Apis::CloudsearchV1::ItemCountByStatus, decorator: Google::Apis::CloudsearchV1::ItemCountByStatus::Representation + + end + end + + class DataSource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :disable_modifications, as: 'disableModifications' + property :disable_serving, as: 'disableServing' + property :display_name, as: 'displayName' + collection :indexing_service_accounts, as: 'indexingServiceAccounts' + collection :items_visibility, as: 'itemsVisibility', class: Google::Apis::CloudsearchV1::GSuitePrincipal, decorator: Google::Apis::CloudsearchV1::GSuitePrincipal::Representation + + property :name, as: 'name' + collection :operation_ids, as: 'operationIds' + property :short_name, as: 'shortName' + end + end + + class DataSourceIndexStats + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :date, as: 'date', class: Google::Apis::CloudsearchV1::Date, decorator: Google::Apis::CloudsearchV1::Date::Representation + + collection :item_count_by_status, as: 'itemCountByStatus', class: Google::Apis::CloudsearchV1::ItemCountByStatus, decorator: Google::Apis::CloudsearchV1::ItemCountByStatus::Representation + + end + end + + class DataSourceRestriction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :filter_options, as: 'filterOptions', class: Google::Apis::CloudsearchV1::FilterOptions, decorator: Google::Apis::CloudsearchV1::FilterOptions::Representation + + property :source, as: 'source', class: Google::Apis::CloudsearchV1::Source, decorator: Google::Apis::CloudsearchV1::Source::Representation + + end + end + + class Date + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :day, as: 'day' + property :month, as: 'month' + property :year, as: 'year' + end + end + + class DateOperatorOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :greater_than_operator_name, as: 'greaterThanOperatorName' + property :less_than_operator_name, as: 'lessThanOperatorName' + property :operator_name, as: 'operatorName' + end + end + + class DatePropertyOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operator_options, as: 'operatorOptions', class: Google::Apis::CloudsearchV1::DateOperatorOptions, decorator: Google::Apis::CloudsearchV1::DateOperatorOptions::Representation + + end + end + + class DateValues + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :values, as: 'values', class: Google::Apis::CloudsearchV1::Date, decorator: Google::Apis::CloudsearchV1::Date::Representation + + end + end + + class DebugOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :enable_debugging, as: 'enableDebugging' + end + end + + class DeleteQueueItemsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :connector_name, as: 'connectorName' + property :debug_options, as: 'debugOptions', class: Google::Apis::CloudsearchV1::DebugOptions, decorator: Google::Apis::CloudsearchV1::DebugOptions::Representation + + property :queue, as: 'queue' + end + end + + class DisplayedProperty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :property_name, as: 'propertyName' + end + end + + class DoubleOperatorOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operator_name, as: 'operatorName' + end + end + + class DoublePropertyOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operator_options, as: 'operatorOptions', class: Google::Apis::CloudsearchV1::DoubleOperatorOptions, decorator: Google::Apis::CloudsearchV1::DoubleOperatorOptions::Representation + + end + end + + class DoubleValues + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :values, as: 'values' + end + end + + class DriveFollowUpRestrict + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :type, as: 'type' + end + end + + class DriveLocationRestrict + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :type, as: 'type' + end + end + + class DriveMimeTypeRestrict + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :type, as: 'type' + end + end + + class DriveTimeSpanRestrict + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :type, as: 'type' + end + end + + class EmailAddress + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :email_address, as: 'emailAddress' + end + end + + class EnumOperatorOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operator_name, as: 'operatorName' + end + end + + class EnumPropertyOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operator_options, as: 'operatorOptions', class: Google::Apis::CloudsearchV1::EnumOperatorOptions, decorator: Google::Apis::CloudsearchV1::EnumOperatorOptions::Representation + + property :ordered_ranking, as: 'orderedRanking' + collection :possible_values, as: 'possibleValues', class: Google::Apis::CloudsearchV1::EnumValuePair, decorator: Google::Apis::CloudsearchV1::EnumValuePair::Representation + + end + end + + class EnumValuePair + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :integer_value, as: 'integerValue' + property :string_value, as: 'stringValue' + end + end + + class EnumValues + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :values, as: 'values' + end + end + + class ErrorInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :error_messages, as: 'errorMessages', class: Google::Apis::CloudsearchV1::ErrorMessage, decorator: Google::Apis::CloudsearchV1::ErrorMessage::Representation + + end + end + + class ErrorMessage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :error_message, as: 'errorMessage' + property :source, as: 'source', class: Google::Apis::CloudsearchV1::Source, decorator: Google::Apis::CloudsearchV1::Source::Representation + + end + end + + class FacetBucket + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :count, as: 'count' + property :percentage, as: 'percentage' + property :value, as: 'value', class: Google::Apis::CloudsearchV1::Value, decorator: Google::Apis::CloudsearchV1::Value::Representation + + end + end + + class FacetOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :object_type, as: 'objectType' + property :operator_name, as: 'operatorName' + property :source_name, as: 'sourceName' + end + end + + class FacetResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :buckets, as: 'buckets', class: Google::Apis::CloudsearchV1::FacetBucket, decorator: Google::Apis::CloudsearchV1::FacetBucket::Representation + + property :object_type, as: 'objectType' + property :operator_name, as: 'operatorName' + property :source_name, as: 'sourceName' + end + end + + class FieldViolation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :field, as: 'field' + end + end + + class Filter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :composite_filter, as: 'compositeFilter', class: Google::Apis::CloudsearchV1::CompositeFilter, decorator: Google::Apis::CloudsearchV1::CompositeFilter::Representation + + property :value_filter, as: 'valueFilter', class: Google::Apis::CloudsearchV1::ValueFilter, decorator: Google::Apis::CloudsearchV1::ValueFilter::Representation + + end + end + + class FilterOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :filter, as: 'filter', class: Google::Apis::CloudsearchV1::Filter, decorator: Google::Apis::CloudsearchV1::Filter::Representation + + property :object_type, as: 'objectType' + end + end + + class FreshnessOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :freshness_duration, as: 'freshnessDuration' + property :freshness_property, as: 'freshnessProperty' + end + end + + class GSuitePrincipal + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :gsuite_domain, as: 'gsuiteDomain' + property :gsuite_group_email, as: 'gsuiteGroupEmail' + property :gsuite_user_email, as: 'gsuiteUserEmail' + end + end + + class GetCustomerIndexStatsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :stats, as: 'stats', class: Google::Apis::CloudsearchV1::CustomerIndexStats, decorator: Google::Apis::CloudsearchV1::CustomerIndexStats::Representation + + end + end + + class GetDataSourceIndexStatsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :stats, as: 'stats', class: Google::Apis::CloudsearchV1::DataSourceIndexStats, decorator: Google::Apis::CloudsearchV1::DataSourceIndexStats::Representation + + end + end + + class HtmlOperatorOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operator_name, as: 'operatorName' + end + end + + class HtmlPropertyOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operator_options, as: 'operatorOptions', class: Google::Apis::CloudsearchV1::HtmlOperatorOptions, decorator: Google::Apis::CloudsearchV1::HtmlOperatorOptions::Representation + + property :retrieval_importance, as: 'retrievalImportance', class: Google::Apis::CloudsearchV1::RetrievalImportance, decorator: Google::Apis::CloudsearchV1::RetrievalImportance::Representation + + end + end + + class HtmlValues + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :values, as: 'values' + end + end + + class IndexItemRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :connector_name, as: 'connectorName' + property :debug_options, as: 'debugOptions', class: Google::Apis::CloudsearchV1::DebugOptions, decorator: Google::Apis::CloudsearchV1::DebugOptions::Representation + + property :item, as: 'item', class: Google::Apis::CloudsearchV1::Item, decorator: Google::Apis::CloudsearchV1::Item::Representation + + property :mode, as: 'mode' + end + end + + class IntegerOperatorOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :greater_than_operator_name, as: 'greaterThanOperatorName' + property :less_than_operator_name, as: 'lessThanOperatorName' + property :operator_name, as: 'operatorName' + end + end + + class IntegerPropertyOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :maximum_value, :numeric_string => true, as: 'maximumValue' + property :minimum_value, :numeric_string => true, as: 'minimumValue' + property :operator_options, as: 'operatorOptions', class: Google::Apis::CloudsearchV1::IntegerOperatorOptions, decorator: Google::Apis::CloudsearchV1::IntegerOperatorOptions::Representation + + property :ordered_ranking, as: 'orderedRanking' + end + end + + class IntegerValues + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :values, as: 'values' + end + end + + class Interaction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :interaction_time, as: 'interactionTime' + property :principal, as: 'principal', class: Google::Apis::CloudsearchV1::Principal, decorator: Google::Apis::CloudsearchV1::Principal::Representation + + property :type, as: 'type' + end + end + + class Item + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :acl, as: 'acl', class: Google::Apis::CloudsearchV1::ItemAcl, decorator: Google::Apis::CloudsearchV1::ItemAcl::Representation + + property :content, as: 'content', class: Google::Apis::CloudsearchV1::ItemContent, decorator: Google::Apis::CloudsearchV1::ItemContent::Representation + + property :item_type, as: 'itemType' + property :metadata, as: 'metadata', class: Google::Apis::CloudsearchV1::ItemMetadata, decorator: Google::Apis::CloudsearchV1::ItemMetadata::Representation + + property :name, as: 'name' + property :payload, :base64 => true, as: 'payload' + property :queue, as: 'queue' + property :status, as: 'status', class: Google::Apis::CloudsearchV1::ItemStatus, decorator: Google::Apis::CloudsearchV1::ItemStatus::Representation + + property :structured_data, as: 'structuredData', class: Google::Apis::CloudsearchV1::ItemStructuredData, decorator: Google::Apis::CloudsearchV1::ItemStructuredData::Representation + + property :version, :base64 => true, as: 'version' + end + end + + class ItemAcl + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :acl_inheritance_type, as: 'aclInheritanceType' + collection :denied_readers, as: 'deniedReaders', class: Google::Apis::CloudsearchV1::Principal, decorator: Google::Apis::CloudsearchV1::Principal::Representation + + property :inherit_acl_from, as: 'inheritAclFrom' + collection :owners, as: 'owners', class: Google::Apis::CloudsearchV1::Principal, decorator: Google::Apis::CloudsearchV1::Principal::Representation + + collection :readers, as: 'readers', class: Google::Apis::CloudsearchV1::Principal, decorator: Google::Apis::CloudsearchV1::Principal::Representation + + end + end + + class ItemContent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_data_ref, as: 'contentDataRef', class: Google::Apis::CloudsearchV1::UploadItemRef, decorator: Google::Apis::CloudsearchV1::UploadItemRef::Representation + + property :content_format, as: 'contentFormat' + property :hash_prop, as: 'hash' + property :inline_content, :base64 => true, as: 'inlineContent' + end + end + + class ItemCountByStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :count, :numeric_string => true, as: 'count' + property :status_code, as: 'statusCode' + end + end + + class ItemMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :container_name, as: 'containerName' + property :content_language, as: 'contentLanguage' + property :create_time, as: 'createTime' + property :hash_prop, as: 'hash' + collection :interactions, as: 'interactions', class: Google::Apis::CloudsearchV1::Interaction, decorator: Google::Apis::CloudsearchV1::Interaction::Representation + + collection :keywords, as: 'keywords' + property :mime_type, as: 'mimeType' + property :object_type, as: 'objectType' + property :search_quality_metadata, as: 'searchQualityMetadata', class: Google::Apis::CloudsearchV1::SearchQualityMetadata, decorator: Google::Apis::CloudsearchV1::SearchQualityMetadata::Representation + + property :source_repository_url, as: 'sourceRepositoryUrl' + property :title, as: 'title' + property :update_time, as: 'updateTime' + end + end + + class ItemStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :processing_errors, as: 'processingErrors', class: Google::Apis::CloudsearchV1::ProcessingError, decorator: Google::Apis::CloudsearchV1::ProcessingError::Representation + + collection :repository_errors, as: 'repositoryErrors', class: Google::Apis::CloudsearchV1::RepositoryError, decorator: Google::Apis::CloudsearchV1::RepositoryError::Representation + + end + end + + class ItemStructuredData + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :hash_prop, as: 'hash' + property :object, as: 'object', class: Google::Apis::CloudsearchV1::StructuredDataObject, decorator: Google::Apis::CloudsearchV1::StructuredDataObject::Representation + + end + end + + class ListDataSourceResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :sources, as: 'sources', class: Google::Apis::CloudsearchV1::DataSource, decorator: Google::Apis::CloudsearchV1::DataSource::Representation + + end + end + + class ListItemNamesForUnmappedIdentityResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :item_names, as: 'itemNames' + property :next_page_token, as: 'nextPageToken' + end + end + + class ListItemsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :items, as: 'items', class: Google::Apis::CloudsearchV1::Item, decorator: Google::Apis::CloudsearchV1::Item::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class ListQuerySourcesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :sources, as: 'sources', class: Google::Apis::CloudsearchV1::QuerySource, decorator: Google::Apis::CloudsearchV1::QuerySource::Representation + + end + end + + class ListSearchApplicationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :search_applications, as: 'searchApplications', class: Google::Apis::CloudsearchV1::SearchApplication, decorator: Google::Apis::CloudsearchV1::SearchApplication::Representation + + end + end + + class ListUnmappedIdentitiesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :unmapped_identities, as: 'unmappedIdentities', class: Google::Apis::CloudsearchV1::UnmappedIdentity, decorator: Google::Apis::CloudsearchV1::UnmappedIdentity::Representation + + end + end + + class MatchRange + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end, as: 'end' + property :start, as: 'start' + end + end + + class Media + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :resource_name, as: 'resourceName' + end + end + + class Metadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :create_time, as: 'createTime' + property :display_options, as: 'displayOptions', class: Google::Apis::CloudsearchV1::ResultDisplayMetadata, decorator: Google::Apis::CloudsearchV1::ResultDisplayMetadata::Representation + + collection :fields, as: 'fields', class: Google::Apis::CloudsearchV1::NamedProperty, decorator: Google::Apis::CloudsearchV1::NamedProperty::Representation + + property :mime_type, as: 'mimeType' + property :object_type, as: 'objectType' + property :owner, as: 'owner', class: Google::Apis::CloudsearchV1::Person, decorator: Google::Apis::CloudsearchV1::Person::Representation + + property :source, as: 'source', class: Google::Apis::CloudsearchV1::Source, decorator: Google::Apis::CloudsearchV1::Source::Representation + + property :update_time, as: 'updateTime' + end + end + + class Metaline + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :properties, as: 'properties', class: Google::Apis::CloudsearchV1::DisplayedProperty, decorator: Google::Apis::CloudsearchV1::DisplayedProperty::Representation + + end + end + + class Name + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + end + end + + class NamedProperty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :boolean_value, as: 'booleanValue' + property :date_values, as: 'dateValues', class: Google::Apis::CloudsearchV1::DateValues, decorator: Google::Apis::CloudsearchV1::DateValues::Representation + + property :double_values, as: 'doubleValues', class: Google::Apis::CloudsearchV1::DoubleValues, decorator: Google::Apis::CloudsearchV1::DoubleValues::Representation + + property :enum_values, as: 'enumValues', class: Google::Apis::CloudsearchV1::EnumValues, decorator: Google::Apis::CloudsearchV1::EnumValues::Representation + + property :html_values, as: 'htmlValues', class: Google::Apis::CloudsearchV1::HtmlValues, decorator: Google::Apis::CloudsearchV1::HtmlValues::Representation + + property :integer_values, as: 'integerValues', class: Google::Apis::CloudsearchV1::IntegerValues, decorator: Google::Apis::CloudsearchV1::IntegerValues::Representation + + property :name, as: 'name' + property :object_values, as: 'objectValues', class: Google::Apis::CloudsearchV1::ObjectValues, decorator: Google::Apis::CloudsearchV1::ObjectValues::Representation + + property :text_values, as: 'textValues', class: Google::Apis::CloudsearchV1::TextValues, decorator: Google::Apis::CloudsearchV1::TextValues::Representation + + property :timestamp_values, as: 'timestampValues', class: Google::Apis::CloudsearchV1::TimestampValues, decorator: Google::Apis::CloudsearchV1::TimestampValues::Representation + + end + end + + class ObjectDefinition + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :options, as: 'options', class: Google::Apis::CloudsearchV1::ObjectOptions, decorator: Google::Apis::CloudsearchV1::ObjectOptions::Representation + + collection :property_definitions, as: 'propertyDefinitions', class: Google::Apis::CloudsearchV1::PropertyDefinition, decorator: Google::Apis::CloudsearchV1::PropertyDefinition::Representation + + end + end + + class ObjectDisplayOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :metalines, as: 'metalines', class: Google::Apis::CloudsearchV1::Metaline, decorator: Google::Apis::CloudsearchV1::Metaline::Representation + + property :object_display_label, as: 'objectDisplayLabel' + end + end + + class ObjectOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_options, as: 'displayOptions', class: Google::Apis::CloudsearchV1::ObjectDisplayOptions, decorator: Google::Apis::CloudsearchV1::ObjectDisplayOptions::Representation + + property :freshness_options, as: 'freshnessOptions', class: Google::Apis::CloudsearchV1::FreshnessOptions, decorator: Google::Apis::CloudsearchV1::FreshnessOptions::Representation + + end + end + + class ObjectPropertyOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :subobject_properties, as: 'subobjectProperties', class: Google::Apis::CloudsearchV1::PropertyDefinition, decorator: Google::Apis::CloudsearchV1::PropertyDefinition::Representation + + end + end + + class ObjectValues + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :values, as: 'values', class: Google::Apis::CloudsearchV1::StructuredDataObject, decorator: Google::Apis::CloudsearchV1::StructuredDataObject::Representation + + end + end + + class Operation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::CloudsearchV1::Status, decorator: Google::Apis::CloudsearchV1::Status::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class PeopleSuggestion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :person, as: 'person', class: Google::Apis::CloudsearchV1::Person, decorator: Google::Apis::CloudsearchV1::Person::Representation + + end + end + + class Person + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :email_addresses, as: 'emailAddresses', class: Google::Apis::CloudsearchV1::EmailAddress, decorator: Google::Apis::CloudsearchV1::EmailAddress::Representation + + property :name, as: 'name' + property :obfuscated_id, as: 'obfuscatedId' + collection :person_names, as: 'personNames', class: Google::Apis::CloudsearchV1::Name, decorator: Google::Apis::CloudsearchV1::Name::Representation + + collection :photos, as: 'photos', class: Google::Apis::CloudsearchV1::Photo, decorator: Google::Apis::CloudsearchV1::Photo::Representation + + end + end + + class Photo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :url, as: 'url' + end + end + + class PollItemsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :connector_name, as: 'connectorName' + property :debug_options, as: 'debugOptions', class: Google::Apis::CloudsearchV1::DebugOptions, decorator: Google::Apis::CloudsearchV1::DebugOptions::Representation + + property :limit, as: 'limit' + property :queue, as: 'queue' + collection :status_codes, as: 'statusCodes' + end + end + + class PollItemsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :items, as: 'items', class: Google::Apis::CloudsearchV1::Item, decorator: Google::Apis::CloudsearchV1::Item::Representation + + end + end + + class Principal + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :group_resource_name, as: 'groupResourceName' + property :gsuite_principal, as: 'gsuitePrincipal', class: Google::Apis::CloudsearchV1::GSuitePrincipal, decorator: Google::Apis::CloudsearchV1::GSuitePrincipal::Representation + + property :user_resource_name, as: 'userResourceName' + end + end + + class ProcessingError + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + property :error_message, as: 'errorMessage' + collection :field_violations, as: 'fieldViolations', class: Google::Apis::CloudsearchV1::FieldViolation, decorator: Google::Apis::CloudsearchV1::FieldViolation::Representation + + end + end + + class PropertyDefinition + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :boolean_property_options, as: 'booleanPropertyOptions', class: Google::Apis::CloudsearchV1::BooleanPropertyOptions, decorator: Google::Apis::CloudsearchV1::BooleanPropertyOptions::Representation + + property :date_property_options, as: 'datePropertyOptions', class: Google::Apis::CloudsearchV1::DatePropertyOptions, decorator: Google::Apis::CloudsearchV1::DatePropertyOptions::Representation + + property :display_options, as: 'displayOptions', class: Google::Apis::CloudsearchV1::PropertyDisplayOptions, decorator: Google::Apis::CloudsearchV1::PropertyDisplayOptions::Representation + + property :double_property_options, as: 'doublePropertyOptions', class: Google::Apis::CloudsearchV1::DoublePropertyOptions, decorator: Google::Apis::CloudsearchV1::DoublePropertyOptions::Representation + + property :enum_property_options, as: 'enumPropertyOptions', class: Google::Apis::CloudsearchV1::EnumPropertyOptions, decorator: Google::Apis::CloudsearchV1::EnumPropertyOptions::Representation + + property :html_property_options, as: 'htmlPropertyOptions', class: Google::Apis::CloudsearchV1::HtmlPropertyOptions, decorator: Google::Apis::CloudsearchV1::HtmlPropertyOptions::Representation + + property :integer_property_options, as: 'integerPropertyOptions', class: Google::Apis::CloudsearchV1::IntegerPropertyOptions, decorator: Google::Apis::CloudsearchV1::IntegerPropertyOptions::Representation + + property :is_facetable, as: 'isFacetable' + property :is_repeatable, as: 'isRepeatable' + property :is_returnable, as: 'isReturnable' + property :is_sortable, as: 'isSortable' + property :name, as: 'name' + property :object_property_options, as: 'objectPropertyOptions', class: Google::Apis::CloudsearchV1::ObjectPropertyOptions, decorator: Google::Apis::CloudsearchV1::ObjectPropertyOptions::Representation + + property :text_property_options, as: 'textPropertyOptions', class: Google::Apis::CloudsearchV1::TextPropertyOptions, decorator: Google::Apis::CloudsearchV1::TextPropertyOptions::Representation + + property :timestamp_property_options, as: 'timestampPropertyOptions', class: Google::Apis::CloudsearchV1::TimestampPropertyOptions, decorator: Google::Apis::CloudsearchV1::TimestampPropertyOptions::Representation + + end + end + + class PropertyDisplayOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_label, as: 'displayLabel' + end + end + + class PushItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_hash, as: 'contentHash' + property :metadata_hash, as: 'metadataHash' + property :payload, :base64 => true, as: 'payload' + property :queue, as: 'queue' + property :repository_error, as: 'repositoryError', class: Google::Apis::CloudsearchV1::RepositoryError, decorator: Google::Apis::CloudsearchV1::RepositoryError::Representation + + property :structured_data_hash, as: 'structuredDataHash' + property :type, as: 'type' + end + end + + class PushItemRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :connector_name, as: 'connectorName' + property :debug_options, as: 'debugOptions', class: Google::Apis::CloudsearchV1::DebugOptions, decorator: Google::Apis::CloudsearchV1::DebugOptions::Representation + + property :item, as: 'item', class: Google::Apis::CloudsearchV1::PushItem, decorator: Google::Apis::CloudsearchV1::PushItem::Representation + + end + end + + class QueryInterpretation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :interpretation_type, as: 'interpretationType' + property :interpreted_query, as: 'interpretedQuery' + end + end + + class QueryInterpretationOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :disable_nl_interpretation, as: 'disableNlInterpretation' + end + end + + class QueryItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :is_synthetic, as: 'isSynthetic' + end + end + + class QueryOperator + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + collection :enum_values, as: 'enumValues' + property :greater_than_operator_name, as: 'greaterThanOperatorName' + property :is_facetable, as: 'isFacetable' + property :is_repeatable, as: 'isRepeatable' + property :is_returnable, as: 'isReturnable' + property :is_sortable, as: 'isSortable' + property :is_suggestable, as: 'isSuggestable' + property :less_than_operator_name, as: 'lessThanOperatorName' + property :operator_name, as: 'operatorName' + property :type, as: 'type' + end + end + + class QuerySource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + collection :operators, as: 'operators', class: Google::Apis::CloudsearchV1::QueryOperator, decorator: Google::Apis::CloudsearchV1::QueryOperator::Representation + + property :short_name, as: 'shortName' + property :source, as: 'source', class: Google::Apis::CloudsearchV1::Source, decorator: Google::Apis::CloudsearchV1::Source::Representation + + end + end + + class QuerySuggestion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class RepositoryError + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :error_message, as: 'errorMessage' + property :http_status_code, as: 'httpStatusCode' + property :type, as: 'type' + end + end + + class RequestOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :debug_options, as: 'debugOptions', class: Google::Apis::CloudsearchV1::DebugOptions, decorator: Google::Apis::CloudsearchV1::DebugOptions::Representation + + property :language_code, as: 'languageCode' + property :search_application_id, as: 'searchApplicationId' + property :time_zone, as: 'timeZone' + end + end + + class ResetSearchApplicationRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :debug_options, as: 'debugOptions', class: Google::Apis::CloudsearchV1::DebugOptions, decorator: Google::Apis::CloudsearchV1::DebugOptions::Representation + + end + end + + class ResponseDebugInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :formatted_debug_info, as: 'formattedDebugInfo' + end + end + + class RestrictItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :drive_follow_up_restrict, as: 'driveFollowUpRestrict', class: Google::Apis::CloudsearchV1::DriveFollowUpRestrict, decorator: Google::Apis::CloudsearchV1::DriveFollowUpRestrict::Representation + + property :drive_location_restrict, as: 'driveLocationRestrict', class: Google::Apis::CloudsearchV1::DriveLocationRestrict, decorator: Google::Apis::CloudsearchV1::DriveLocationRestrict::Representation + + property :drive_mime_type_restrict, as: 'driveMimeTypeRestrict', class: Google::Apis::CloudsearchV1::DriveMimeTypeRestrict, decorator: Google::Apis::CloudsearchV1::DriveMimeTypeRestrict::Representation + + property :drive_time_span_restrict, as: 'driveTimeSpanRestrict', class: Google::Apis::CloudsearchV1::DriveTimeSpanRestrict, decorator: Google::Apis::CloudsearchV1::DriveTimeSpanRestrict::Representation + + property :search_operator, as: 'searchOperator' + end + end + + class ResultCounts + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :source_result_counts, as: 'sourceResultCounts', class: Google::Apis::CloudsearchV1::SourceResultCount, decorator: Google::Apis::CloudsearchV1::SourceResultCount::Representation + + end + end + + class ResultDebugInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :formatted_debug_info, as: 'formattedDebugInfo' + end + end + + class ResultDisplayField + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :label, as: 'label' + property :operator_name, as: 'operatorName' + property :property, as: 'property', class: Google::Apis::CloudsearchV1::NamedProperty, decorator: Google::Apis::CloudsearchV1::NamedProperty::Representation + + end + end + + class ResultDisplayLine + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :fields, as: 'fields', class: Google::Apis::CloudsearchV1::ResultDisplayField, decorator: Google::Apis::CloudsearchV1::ResultDisplayField::Representation + + end + end + + class ResultDisplayMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :metalines, as: 'metalines', class: Google::Apis::CloudsearchV1::ResultDisplayLine, decorator: Google::Apis::CloudsearchV1::ResultDisplayLine::Representation + + property :object_type_label, as: 'objectTypeLabel' + end + end + + class RetrievalImportance + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :importance, as: 'importance' + end + end + + class Schema + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :object_definitions, as: 'objectDefinitions', class: Google::Apis::CloudsearchV1::ObjectDefinition, decorator: Google::Apis::CloudsearchV1::ObjectDefinition::Representation + + collection :operation_ids, as: 'operationIds' + end + end + + class ScoringConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :disable_freshness, as: 'disableFreshness' + property :disable_personalization, as: 'disablePersonalization' + end + end + + class SearchApplication + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :data_source_restrictions, as: 'dataSourceRestrictions', class: Google::Apis::CloudsearchV1::DataSourceRestriction, decorator: Google::Apis::CloudsearchV1::DataSourceRestriction::Representation + + collection :default_facet_options, as: 'defaultFacetOptions', class: Google::Apis::CloudsearchV1::FacetOptions, decorator: Google::Apis::CloudsearchV1::FacetOptions::Representation + + property :default_sort_options, as: 'defaultSortOptions', class: Google::Apis::CloudsearchV1::SortOptions, decorator: Google::Apis::CloudsearchV1::SortOptions::Representation + + property :display_name, as: 'displayName' + property :name, as: 'name' + collection :operation_ids, as: 'operationIds' + property :scoring_config, as: 'scoringConfig', class: Google::Apis::CloudsearchV1::ScoringConfig, decorator: Google::Apis::CloudsearchV1::ScoringConfig::Representation + + collection :source_config, as: 'sourceConfig', class: Google::Apis::CloudsearchV1::SourceConfig, decorator: Google::Apis::CloudsearchV1::SourceConfig::Representation + + end + end + + class SearchQualityMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :quality, as: 'quality' + end + end + + class SearchRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :data_source_restrictions, as: 'dataSourceRestrictions', class: Google::Apis::CloudsearchV1::DataSourceRestriction, decorator: Google::Apis::CloudsearchV1::DataSourceRestriction::Representation + + collection :facet_options, as: 'facetOptions', class: Google::Apis::CloudsearchV1::FacetOptions, decorator: Google::Apis::CloudsearchV1::FacetOptions::Representation + + property :page_size, as: 'pageSize' + property :query, as: 'query' + property :query_interpretation_options, as: 'queryInterpretationOptions', class: Google::Apis::CloudsearchV1::QueryInterpretationOptions, decorator: Google::Apis::CloudsearchV1::QueryInterpretationOptions::Representation + + property :request_options, as: 'requestOptions', class: Google::Apis::CloudsearchV1::RequestOptions, decorator: Google::Apis::CloudsearchV1::RequestOptions::Representation + + property :sort_options, as: 'sortOptions', class: Google::Apis::CloudsearchV1::SortOptions, decorator: Google::Apis::CloudsearchV1::SortOptions::Representation + + property :start, as: 'start' + end + end + + class SearchResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :debug_info, as: 'debugInfo', class: Google::Apis::CloudsearchV1::ResponseDebugInfo, decorator: Google::Apis::CloudsearchV1::ResponseDebugInfo::Representation + + property :error_info, as: 'errorInfo', class: Google::Apis::CloudsearchV1::ErrorInfo, decorator: Google::Apis::CloudsearchV1::ErrorInfo::Representation + + collection :facet_results, as: 'facetResults', class: Google::Apis::CloudsearchV1::FacetResult, decorator: Google::Apis::CloudsearchV1::FacetResult::Representation + + property :has_more_results, as: 'hasMoreResults' + property :query_interpretation, as: 'queryInterpretation', class: Google::Apis::CloudsearchV1::QueryInterpretation, decorator: Google::Apis::CloudsearchV1::QueryInterpretation::Representation + + property :result_count_estimate, :numeric_string => true, as: 'resultCountEstimate' + property :result_count_exact, :numeric_string => true, as: 'resultCountExact' + property :result_counts, as: 'resultCounts', class: Google::Apis::CloudsearchV1::ResultCounts, decorator: Google::Apis::CloudsearchV1::ResultCounts::Representation + + collection :results, as: 'results', class: Google::Apis::CloudsearchV1::SearchResult, decorator: Google::Apis::CloudsearchV1::SearchResult::Representation + + collection :spell_results, as: 'spellResults', class: Google::Apis::CloudsearchV1::SpellResult, decorator: Google::Apis::CloudsearchV1::SpellResult::Representation + + collection :structured_results, as: 'structuredResults', class: Google::Apis::CloudsearchV1::StructuredResult, decorator: Google::Apis::CloudsearchV1::StructuredResult::Representation + + end + end + + class SearchResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :clustered_results, as: 'clusteredResults', class: Google::Apis::CloudsearchV1::SearchResult, decorator: Google::Apis::CloudsearchV1::SearchResult::Representation + + property :debug_info, as: 'debugInfo', class: Google::Apis::CloudsearchV1::ResultDebugInfo, decorator: Google::Apis::CloudsearchV1::ResultDebugInfo::Representation + + property :metadata, as: 'metadata', class: Google::Apis::CloudsearchV1::Metadata, decorator: Google::Apis::CloudsearchV1::Metadata::Representation + + property :snippet, as: 'snippet', class: Google::Apis::CloudsearchV1::Snippet, decorator: Google::Apis::CloudsearchV1::Snippet::Representation + + property :title, as: 'title' + property :url, as: 'url' + end + end + + class Snippet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :match_ranges, as: 'matchRanges', class: Google::Apis::CloudsearchV1::MatchRange, decorator: Google::Apis::CloudsearchV1::MatchRange::Representation + + property :snippet, as: 'snippet' + end + end + + class SortOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operator_name, as: 'operatorName' + property :sort_order, as: 'sortOrder' + end + end + + class Source + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :predefined_source, as: 'predefinedSource' + end + end + + class SourceConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :crowding_config, as: 'crowdingConfig', class: Google::Apis::CloudsearchV1::SourceCrowdingConfig, decorator: Google::Apis::CloudsearchV1::SourceCrowdingConfig::Representation + + property :scoring_config, as: 'scoringConfig', class: Google::Apis::CloudsearchV1::SourceScoringConfig, decorator: Google::Apis::CloudsearchV1::SourceScoringConfig::Representation + + property :source, as: 'source', class: Google::Apis::CloudsearchV1::Source, decorator: Google::Apis::CloudsearchV1::Source::Representation + + end + end + + class SourceCrowdingConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :field, as: 'field' + property :num_results, as: 'numResults' + property :num_suggestions, as: 'numSuggestions' + property :source, as: 'source' + end + end + + class SourceResultCount + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :has_more_results, as: 'hasMoreResults' + property :result_count_estimate, :numeric_string => true, as: 'resultCountEstimate' + property :result_count_exact, :numeric_string => true, as: 'resultCountExact' + property :source, as: 'source', class: Google::Apis::CloudsearchV1::Source, decorator: Google::Apis::CloudsearchV1::Source::Representation + + end + end + + class SourceScoringConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :source_importance, as: 'sourceImportance' + end + end + + class SpellResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :suggested_query, as: 'suggestedQuery' + end + end + + class StartUploadItemRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :connector_name, as: 'connectorName' + property :debug_options, as: 'debugOptions', class: Google::Apis::CloudsearchV1::DebugOptions, decorator: Google::Apis::CloudsearchV1::DebugOptions::Representation + + 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 StructuredDataObject + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :properties, as: 'properties', class: Google::Apis::CloudsearchV1::NamedProperty, decorator: Google::Apis::CloudsearchV1::NamedProperty::Representation + + end + end + + class StructuredResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :person, as: 'person', class: Google::Apis::CloudsearchV1::Person, decorator: Google::Apis::CloudsearchV1::Person::Representation + + end + end + + class SuggestRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :data_source_restrictions, as: 'dataSourceRestrictions', class: Google::Apis::CloudsearchV1::DataSourceRestriction, decorator: Google::Apis::CloudsearchV1::DataSourceRestriction::Representation + + property :query, as: 'query' + property :request_options, as: 'requestOptions', class: Google::Apis::CloudsearchV1::RequestOptions, decorator: Google::Apis::CloudsearchV1::RequestOptions::Representation + + end + end + + class SuggestResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :suggest_results, as: 'suggestResults', class: Google::Apis::CloudsearchV1::SuggestResult, decorator: Google::Apis::CloudsearchV1::SuggestResult::Representation + + end + end + + class SuggestResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :people_suggestion, as: 'peopleSuggestion', class: Google::Apis::CloudsearchV1::PeopleSuggestion, decorator: Google::Apis::CloudsearchV1::PeopleSuggestion::Representation + + property :query_suggestion, as: 'querySuggestion', class: Google::Apis::CloudsearchV1::QuerySuggestion, decorator: Google::Apis::CloudsearchV1::QuerySuggestion::Representation + + property :source, as: 'source', class: Google::Apis::CloudsearchV1::Source, decorator: Google::Apis::CloudsearchV1::Source::Representation + + property :suggested_query, as: 'suggestedQuery' + end + end + + class TextOperatorOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :exact_match_with_operator, as: 'exactMatchWithOperator' + property :operator_name, as: 'operatorName' + end + end + + class TextPropertyOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operator_options, as: 'operatorOptions', class: Google::Apis::CloudsearchV1::TextOperatorOptions, decorator: Google::Apis::CloudsearchV1::TextOperatorOptions::Representation + + property :retrieval_importance, as: 'retrievalImportance', class: Google::Apis::CloudsearchV1::RetrievalImportance, decorator: Google::Apis::CloudsearchV1::RetrievalImportance::Representation + + end + end + + class TextValues + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :values, as: 'values' + end + end + + class TimestampOperatorOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :greater_than_operator_name, as: 'greaterThanOperatorName' + property :less_than_operator_name, as: 'lessThanOperatorName' + property :operator_name, as: 'operatorName' + end + end + + class TimestampPropertyOptions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operator_options, as: 'operatorOptions', class: Google::Apis::CloudsearchV1::TimestampOperatorOptions, decorator: Google::Apis::CloudsearchV1::TimestampOperatorOptions::Representation + + end + end + + class TimestampValues + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :values, as: 'values' + end + end + + class UnmappedIdentity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :external_identity, as: 'externalIdentity', class: Google::Apis::CloudsearchV1::Principal, decorator: Google::Apis::CloudsearchV1::Principal::Representation + + property :resolution_status_code, as: 'resolutionStatusCode' + end + end + + class UnreserveItemsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :connector_name, as: 'connectorName' + property :debug_options, as: 'debugOptions', class: Google::Apis::CloudsearchV1::DebugOptions, decorator: Google::Apis::CloudsearchV1::DebugOptions::Representation + + property :queue, as: 'queue' + end + end + + class UpdateDataSourceRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :debug_options, as: 'debugOptions', class: Google::Apis::CloudsearchV1::DebugOptions, decorator: Google::Apis::CloudsearchV1::DebugOptions::Representation + + property :source, as: 'source', class: Google::Apis::CloudsearchV1::DataSource, decorator: Google::Apis::CloudsearchV1::DataSource::Representation + + end + end + + class UpdateSchemaRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :debug_options, as: 'debugOptions', class: Google::Apis::CloudsearchV1::DebugOptions, decorator: Google::Apis::CloudsearchV1::DebugOptions::Representation + + property :schema, as: 'schema', class: Google::Apis::CloudsearchV1::Schema, decorator: Google::Apis::CloudsearchV1::Schema::Representation + + property :validate_only, as: 'validateOnly' + end + end + + class UploadItemRef + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + end + end + + class Value + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :boolean_value, as: 'booleanValue' + property :date_value, as: 'dateValue', class: Google::Apis::CloudsearchV1::Date, decorator: Google::Apis::CloudsearchV1::Date::Representation + + property :double_value, as: 'doubleValue' + property :integer_value, :numeric_string => true, as: 'integerValue' + property :string_value, as: 'stringValue' + property :timestamp_value, as: 'timestampValue' + end + end + + class ValueFilter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :operator_name, as: 'operatorName' + property :value, as: 'value', class: Google::Apis::CloudsearchV1::Value, decorator: Google::Apis::CloudsearchV1::Value::Representation + + end + end + end + end +end diff --git a/generated/google/apis/cloudsearch_v1/service.rb b/generated/google/apis/cloudsearch_v1/service.rb new file mode 100644 index 000000000..3e96853b0 --- /dev/null +++ b/generated/google/apis/cloudsearch_v1/service.rb @@ -0,0 +1,1351 @@ +# 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 CloudsearchV1 + # Cloud Search API + # + # Cloud Search provides cloud-based search capabilities over G Suite data. The + # Cloud Search API allows indexing of non-G Suite data into Cloud Search. + # + # @example + # require 'google/apis/cloudsearch_v1' + # + # Cloudsearch = Google::Apis::CloudsearchV1 # Alias the module + # service = Cloudsearch::CloudSearchService.new + # + # @see https://gsuite.google.com/products/cloud-search/ + class CloudSearchService < 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://cloudsearch.googleapis.com/', '') + @batch_path = 'batch' + end + + # List all unmapped identities for a specific item. + # @param [String] parent + # The name of the item, in the following format: + # datasources/`source_id`/items/`ID` + # @param [Fixnum] page_size + # Maximum number of items to fetch in a request. + # Defaults to 100. + # @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::CloudsearchV1::ListUnmappedIdentitiesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_debug_datasource_item_unmappedids(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/debug/{+parent}/unmappedids', options) + command.response_representation = Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse::Representation + command.response_class = Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse + 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 names of items associated with an unmapped identity. + # @param [String] parent + # The name of the identity source, in the following format: + # identitysources/`source_id`` + # @param [String] group_resource_name + # @param [Fixnum] page_size + # Maximum number of items to fetch in a request. + # Defaults to 100. + # @param [String] page_token + # The next_page_token value returned from a previous List request, if any. + # @param [String] user_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::CloudsearchV1::ListItemNamesForUnmappedIdentityResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::ListItemNamesForUnmappedIdentityResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_debug_identitysource_item_forunmappedidentity(parent, group_resource_name: nil, page_size: nil, page_token: nil, user_resource_name: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/debug/{+parent}/items:forunmappedidentity', options) + command.response_representation = Google::Apis::CloudsearchV1::ListItemNamesForUnmappedIdentityResponse::Representation + command.response_class = Google::Apis::CloudsearchV1::ListItemNamesForUnmappedIdentityResponse + command.params['parent'] = parent unless parent.nil? + command.query['groupResourceName'] = group_resource_name unless group_resource_name.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['userResourceName'] = user_resource_name unless user_resource_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 unmapped user identities for an identity source. + # @param [String] parent + # The name of the identity source, in the following format: + # identitysources/`source_id` + # @param [Fixnum] page_size + # Maximum number of items to fetch in a request. + # Defaults to 100. + # @param [String] page_token + # The next_page_token value returned from a previous List request, if any. + # @param [String] resolution_status_code + # Limit users selection to this status. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::CloudsearchV1::ListUnmappedIdentitiesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_debug_identitysource_unmappedids(parent, page_size: nil, page_token: nil, resolution_status_code: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/debug/{+parent}/unmappedids', options) + command.response_representation = Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse::Representation + command.response_class = Google::Apis::CloudsearchV1::ListUnmappedIdentitiesResponse + 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['resolutionStatusCode'] = resolution_status_code unless resolution_status_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 schema of a data source. + # @param [String] name + # Name of the data source to delete Schema. Format: + # datasources/`source_id` + # @param [Boolean] debug_options_enable_debugging + # If set, the request will enable debugging features of Cloud Search. + # Only turn on this field, if asked by Google to help with debugging. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::CloudsearchV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::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_indexing_datasource_schema(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/indexing/{+name}/schema', options) + command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation + command.response_class = Google::Apis::CloudsearchV1::Operation + command.params['name'] = name unless name.nil? + command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.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 schema of a data source. + # @param [String] name + # Name of the data source to get Schema. Format: + # datasources/`source_id` + # @param [Boolean] debug_options_enable_debugging + # If set, the request will enable debugging features of Cloud Search. + # Only turn on this field, if asked by Google to help with debugging. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::CloudsearchV1::Schema] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::Schema] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_indexing_datasource_schema(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/indexing/{+name}/schema', options) + command.response_representation = Google::Apis::CloudsearchV1::Schema::Representation + command.response_class = Google::Apis::CloudsearchV1::Schema + command.params['name'] = name unless name.nil? + command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.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 schema of a data source. + # @param [String] name + # Name of the data source to update Schema. Format: + # datasources/`source_id` + # @param [Google::Apis::CloudsearchV1::UpdateSchemaRequest] update_schema_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::CloudsearchV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::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_datasource_schema(name, update_schema_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/indexing/{+name}/schema', options) + command.request_representation = Google::Apis::CloudsearchV1::UpdateSchemaRequest::Representation + command.request_object = update_schema_request_object + command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation + command.response_class = Google::Apis::CloudsearchV1::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 + + # Deletes Item resource for the + # specified resource name. + # @param [String] name + # Required. Name of the item to delete. + # Format: datasources/`source_id`/items/`item_id` + # @param [String] connector_name + # Name of connector making this call. + #
Format: datasources/`source_id`/connectors/`ID` + # @param [Boolean] debug_options_enable_debugging + # If set, the request will enable debugging features of Cloud Search. + # Only turn on this field, if asked by Google to help with debugging. + # @param [String] mode + # Required. The RequestMode for this request. + # @param [String] version + # Required. The incremented version of the item to delete from the index. + # The indexing system stores the version from the datasource as a + # byte string and compares the Item version in the index + # to the version of the queued Item using lexical ordering. + #

+ # Cloud Search Indexing won't delete any queued item with + # a version value that is less than or equal to + # the version of the currently indexed item. + # The maximum length for this field is 1024 bytes. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::CloudsearchV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::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_indexing_datasource_item(name, connector_name: nil, debug_options_enable_debugging: nil, mode: nil, version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/indexing/{+name}', options) + command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation + command.response_class = Google::Apis::CloudsearchV1::Operation + command.params['name'] = name unless name.nil? + command.query['connectorName'] = connector_name unless connector_name.nil? + command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.nil? + command.query['mode'] = mode unless mode.nil? + command.query['version'] = version unless version.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 items in a queue. This method is useful for deleting stale + # items. + # @param [String] name + # Name of the Data Source to delete items in a queue. + # Format: datasources/`source_id` + # @param [Google::Apis::CloudsearchV1::DeleteQueueItemsRequest] delete_queue_items_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::CloudsearchV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::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_queue_items(name, delete_queue_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/indexing/{+name}/items:deleteQueueItems', options) + command.request_representation = Google::Apis::CloudsearchV1::DeleteQueueItemsRequest::Representation + command.request_object = delete_queue_items_request_object + command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation + command.response_class = Google::Apis::CloudsearchV1::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 Item resource by item name. + # @param [String] name + # Name of the item to get info. + # Format: datasources/`source_id`/items/`item_id` + # @param [String] connector_name + # Name of connector making this call. + #
Format: datasources/`source_id`/connectors/`ID` + # @param [Boolean] debug_options_enable_debugging + # If set, the request will enable debugging features of Cloud Search. + # Only turn on this field, if asked by Google to help with debugging. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::CloudsearchV1::Item] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::Item] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_indexing_datasource_item(name, connector_name: nil, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/indexing/{+name}', options) + command.response_representation = Google::Apis::CloudsearchV1::Item::Representation + command.response_class = Google::Apis::CloudsearchV1::Item + command.params['name'] = name unless name.nil? + command.query['connectorName'] = connector_name unless connector_name.nil? + command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.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 Item ACL, metadata, and + # content. It will insert the Item if it + # does not exist. + # This method does not support partial updates. Fields with no provided + # values are cleared out in the Cloud Search index. + # @param [String] name + # Name of the Item. Format: + # datasources/`source_id`/items/`item_id` + #
This is a required field. + # The maximum length is 1536 characters. + # @param [Google::Apis::CloudsearchV1::IndexItemRequest] index_item_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::CloudsearchV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::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 index_item(name, index_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/indexing/{+name}:index', options) + command.request_representation = Google::Apis::CloudsearchV1::IndexItemRequest::Representation + command.request_object = index_item_request_object + command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation + command.response_class = Google::Apis::CloudsearchV1::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 all or a subset of Item resources. + # @param [String] name + # Name of the Data Source to list Items. Format: + # datasources/`source_id` + # @param [Boolean] brief + # When set to true, the indexing system only populates the following fields: + # name, + # version, + # metadata.hash, + # structured_data.hash, + # content.hash. + #
If this value is false, then all the fields are populated in Item. + # @param [String] connector_name + # Name of connector making this call. + #
Format: datasources/`source_id`/connectors/`ID` + # @param [Boolean] debug_options_enable_debugging + # If set, the request will enable debugging features of Cloud Search. + # Only turn on this field, if asked by Google to help with debugging. + # @param [Fixnum] page_size + # Maximum number of items to fetch in a request. + # The max value is 1000 when brief is true. The max value is 10 if brief + # is false. + #
The default value is 10 + # @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::CloudsearchV1::ListItemsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::ListItemsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_indexing_datasource_items(name, brief: nil, connector_name: nil, debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/indexing/{+name}/items', options) + command.response_representation = Google::Apis::CloudsearchV1::ListItemsResponse::Representation + command.response_class = Google::Apis::CloudsearchV1::ListItemsResponse + command.params['name'] = name unless name.nil? + command.query['brief'] = brief unless brief.nil? + command.query['connectorName'] = connector_name unless connector_name.nil? + command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.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 + + # Polls for unreserved items from the indexing queue and marks a + # set as reserved, starting with items that have + # the oldest timestamp from the highest priority + # ItemStatus. + # The priority order is as follows:
+ # ERROR + #
+ # MODIFIED + #
+ # NEW_ITEM + #
+ # ACCEPTED + #
+ # Reserving items ensures that polling from other threads + # cannot create overlapping sets. + # After handling the reserved items, the client should put items back + # into the unreserved state, either by calling + # index, + # or by calling + # push with + # the type REQUEUE. + # Items automatically become available (unreserved) after 4 hours even if no + # update or push method is called. + # @param [String] name + # Name of the Data Source to poll items. + # Format: datasources/`source_id` + # @param [Google::Apis::CloudsearchV1::PollItemsRequest] poll_items_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::CloudsearchV1::PollItemsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::PollItemsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def poll_items(name, poll_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/indexing/{+name}/items:poll', options) + command.request_representation = Google::Apis::CloudsearchV1::PollItemsRequest::Representation + command.request_object = poll_items_request_object + command.response_representation = Google::Apis::CloudsearchV1::PollItemsResponse::Representation + command.response_class = Google::Apis::CloudsearchV1::PollItemsResponse + 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 + + # Pushes an item onto a queue for later polling and updating. + # @param [String] name + # Name of the item to + # push into the indexing queue.
+ # Format: datasources/`source_id`/items/`ID` + #
This is a required field. + # The maximum length is 1536 characters. + # @param [Google::Apis::CloudsearchV1::PushItemRequest] push_item_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::CloudsearchV1::Item] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::Item] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def push_item(name, push_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/indexing/{+name}:push', options) + command.request_representation = Google::Apis::CloudsearchV1::PushItemRequest::Representation + command.request_object = push_item_request_object + command.response_representation = Google::Apis::CloudsearchV1::Item::Representation + command.response_class = Google::Apis::CloudsearchV1::Item + 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 + + # Unreserves all items from a queue, making them all eligible to be + # polled. This method is useful for resetting the indexing queue + # after a connector has been restarted. + # @param [String] name + # Name of the Data Source to unreserve all items. + # Format: datasources/`source_id` + # @param [Google::Apis::CloudsearchV1::UnreserveItemsRequest] unreserve_items_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::CloudsearchV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::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 unreserve_items(name, unreserve_items_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/indexing/{+name}/items:unreserve', options) + command.request_representation = Google::Apis::CloudsearchV1::UnreserveItemsRequest::Representation + command.request_object = unreserve_items_request_object + command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation + command.response_class = Google::Apis::CloudsearchV1::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 an upload session for uploading item content. For items smaller + # than 100 KiB, it's easier to embed the content + # inline within + # update. + # @param [String] name + # Name of the Data Source to start a resumable upload. + # Format: datasources/`source_id` + # @param [Google::Apis::CloudsearchV1::StartUploadItemRequest] start_upload_item_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::CloudsearchV1::UploadItemRef] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::UploadItemRef] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def upload_indexing_datasource_item(name, start_upload_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/indexing/{+name}:upload', options) + command.request_representation = Google::Apis::CloudsearchV1::StartUploadItemRequest::Representation + command.request_object = start_upload_item_request_object + command.response_representation = Google::Apis::CloudsearchV1::UploadItemRef::Representation + command.response_class = Google::Apis::CloudsearchV1::UploadItemRef + 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 + + # Uploads media for indexing. + # The upload endpoint supports direct and resumable upload protocols and + # is intended for large items that can not be inlined during index requests. To + # index large content: + # 1. Call upload to begin + # a session and get the item reference. + # 1. Upload the content using the item reference's resource name. + # 1. Call index with the item + # reference as the content. + # For additional information, see + # [Create a content connector using the REST API](https://developers.google.com/ + # cloud-search/docs/guides/content-connector#rest). + # @param [String] resource_name + # Name of the media that is being downloaded. See + # ReadRequest.resource_name. + # @param [Google::Apis::CloudsearchV1::Media] media_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 [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::CloudsearchV1::Media] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::Media] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def upload_medium(resource_name, media_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) + if upload_source.nil? + command = make_simple_command(:post, 'v1/media/{+resourceName}', options) + else + command = make_upload_command(:post, 'v1/media/{+resourceName}', options) + command.upload_source = upload_source + command.upload_content_type = content_type + end + command.request_representation = Google::Apis::CloudsearchV1::Media::Representation + command.request_object = media_object + command.response_representation = Google::Apis::CloudsearchV1::Media::Representation + command.response_class = Google::Apis::CloudsearchV1::Media + command.params['resourceName'] = resource_name unless resource_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::CloudsearchV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::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::CloudsearchV1::Operation::Representation + command.response_class = Google::Apis::CloudsearchV1::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 + + # The Cloud Search Query API provides the search method, which returns + # the most relevant results from a user query. The results can come from + # G Suite Apps, such as Gmail or Google Drive, or they can come from data + # that you have indexed from a third party. + # @param [Google::Apis::CloudsearchV1::SearchRequest] search_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::CloudsearchV1::SearchResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::SearchResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_query(search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/query/search', options) + command.request_representation = Google::Apis::CloudsearchV1::SearchRequest::Representation + command.request_object = search_request_object + command.response_representation = Google::Apis::CloudsearchV1::SearchResponse::Representation + command.response_class = Google::Apis::CloudsearchV1::SearchResponse + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Provides suggestions for autocompleting the query. + # @param [Google::Apis::CloudsearchV1::SuggestRequest] suggest_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::CloudsearchV1::SuggestResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::SuggestResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def suggest_query(suggest_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/query/suggest', options) + command.request_representation = Google::Apis::CloudsearchV1::SuggestRequest::Representation + command.request_object = suggest_request_object + command.response_representation = Google::Apis::CloudsearchV1::SuggestResponse::Representation + command.response_class = Google::Apis::CloudsearchV1::SuggestResponse + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns list of sources that user can use for Search and Suggest APIs. + # @param [String] page_token + # Number of sources to return in the response. + # @param [Boolean] request_options_debug_options_enable_debugging + # If set, the request will enable debugging features of Cloud Search. + # Only turn on this field, if asked by Google to help with debugging. + # @param [String] request_options_language_code + # 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. + # For translations. + # @param [String] request_options_search_application_id + # Id of the application created using SearchApplicationsService. + # @param [String] request_options_time_zone + # Current user's time zone id, such as "America/Los_Angeles" or + # "Australia/Sydney". These IDs are defined by + # [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) + # project, and currently available in the file + # [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::CloudsearchV1::ListQuerySourcesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::ListQuerySourcesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_query_sources(page_token: nil, request_options_debug_options_enable_debugging: nil, request_options_language_code: nil, request_options_search_application_id: nil, request_options_time_zone: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/query/sources', options) + command.response_representation = Google::Apis::CloudsearchV1::ListQuerySourcesResponse::Representation + command.response_class = Google::Apis::CloudsearchV1::ListQuerySourcesResponse + command.query['pageToken'] = page_token unless page_token.nil? + command.query['requestOptions.debugOptions.enableDebugging'] = request_options_debug_options_enable_debugging unless request_options_debug_options_enable_debugging.nil? + command.query['requestOptions.languageCode'] = request_options_language_code unless request_options_language_code.nil? + command.query['requestOptions.searchApplicationId'] = request_options_search_application_id unless request_options_search_application_id.nil? + command.query['requestOptions.timeZone'] = request_options_time_zone unless request_options_time_zone.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 data source. + # @param [Google::Apis::CloudsearchV1::DataSource] data_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::CloudsearchV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::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_setting_datasource(data_source_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/settings/datasources', options) + command.request_representation = Google::Apis::CloudsearchV1::DataSource::Representation + command.request_object = data_source_object + command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation + command.response_class = Google::Apis::CloudsearchV1::Operation + 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 data source. + # @param [String] name + # Name of the data source. + # Format: datasources/`source_id`. + # @param [Boolean] debug_options_enable_debugging + # If set, the request will enable debugging features of Cloud Search. + # Only turn on this field, if asked by Google to help with debugging. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::CloudsearchV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::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_setting_datasource(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/settings/{+name}', options) + command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation + command.response_class = Google::Apis::CloudsearchV1::Operation + command.params['name'] = name unless name.nil? + command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.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 data source. + # @param [String] name + # Name of the data source resource. + # Format: datasources/`source_id`. + # @param [Boolean] debug_options_enable_debugging + # If set, the request will enable debugging features of Cloud Search. + # Only turn on this field, if asked by Google to help with debugging. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::CloudsearchV1::DataSource] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::DataSource] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_setting_datasource(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/settings/{+name}', options) + command.response_representation = Google::Apis::CloudsearchV1::DataSource::Representation + command.response_class = Google::Apis::CloudsearchV1::DataSource + command.params['name'] = name unless name.nil? + command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.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 data sources. + # @param [Boolean] debug_options_enable_debugging + # If set, the request will enable debugging features of Cloud Search. + # Only turn on this field, if asked by Google to help with debugging. + # @param [Fixnum] page_size + # Maximum number of data sources to fetch in a request. + # The max value is 100. + #
The default value is 10 + # @param [String] page_token + # Starting index of the 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudsearchV1::ListDataSourceResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::ListDataSourceResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_setting_datasources(debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/settings/datasources', options) + command.response_representation = Google::Apis::CloudsearchV1::ListDataSourceResponse::Representation + command.response_class = Google::Apis::CloudsearchV1::ListDataSourceResponse + command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.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 data source. + # @param [String] name + # Name of the data source resource. + # Format: datasources/`source_id`. + #
The name is ignored when creating a data source. + # @param [Google::Apis::CloudsearchV1::UpdateDataSourceRequest] update_data_source_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::CloudsearchV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::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_datasource_data_source(name, update_data_source_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/settings/{+name}', options) + command.request_representation = Google::Apis::CloudsearchV1::UpdateDataSourceRequest::Representation + command.request_object = update_data_source_request_object + command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation + command.response_class = Google::Apis::CloudsearchV1::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 search application. + # @param [Google::Apis::CloudsearchV1::SearchApplication] search_application_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::CloudsearchV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::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_setting_searchapplication(search_application_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/settings/searchapplications', options) + command.request_representation = Google::Apis::CloudsearchV1::SearchApplication::Representation + command.request_object = search_application_object + command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation + command.response_class = Google::Apis::CloudsearchV1::Operation + 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 search application. + # @param [String] name + # The name of the search application to be deleted. + #
Format: applications/`application_id`. + # @param [Boolean] debug_options_enable_debugging + # If set, the request will enable debugging features of Cloud Search. + # Only turn on this field, if asked by Google to help with debugging. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::CloudsearchV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::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_setting_searchapplication(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/settings/{+name}', options) + command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation + command.response_class = Google::Apis::CloudsearchV1::Operation + command.params['name'] = name unless name.nil? + command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.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 specified search application. + # @param [String] name + # Name of the search application. + #
Format: applications/`application_id`. + # @param [Boolean] debug_options_enable_debugging + # If set, the request will enable debugging features of Cloud Search. + # Only turn on this field, if asked by Google to help with debugging. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::CloudsearchV1::SearchApplication] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::SearchApplication] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_setting_searchapplication(name, debug_options_enable_debugging: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/settings/{+name}', options) + command.response_representation = Google::Apis::CloudsearchV1::SearchApplication::Representation + command.response_class = Google::Apis::CloudsearchV1::SearchApplication + command.params['name'] = name unless name.nil? + command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.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 search applications. + # @param [Boolean] debug_options_enable_debugging + # If set, the request will enable debugging features of Cloud Search. + # Only turn on this field, if asked by Google to help with debugging. + # @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. + #
The default value is 10 + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::CloudsearchV1::ListSearchApplicationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::ListSearchApplicationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_setting_searchapplications(debug_options_enable_debugging: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/settings/searchapplications', options) + command.response_representation = Google::Apis::CloudsearchV1::ListSearchApplicationsResponse::Representation + command.response_class = Google::Apis::CloudsearchV1::ListSearchApplicationsResponse + command.query['debugOptions.enableDebugging'] = debug_options_enable_debugging unless debug_options_enable_debugging.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 + + # Resets a search application to default settings. This will return an empty + # response. + # @param [String] name + # The name of the search application to be reset. + #
Format: applications/`application_id`. + # @param [Google::Apis::CloudsearchV1::ResetSearchApplicationRequest] reset_search_application_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::CloudsearchV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::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_searchapplication_search_application(name, reset_search_application_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/settings/{+name}:reset', options) + command.request_representation = Google::Apis::CloudsearchV1::ResetSearchApplicationRequest::Representation + command.request_object = reset_search_application_request_object + command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation + command.response_class = Google::Apis::CloudsearchV1::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 + + # Updates a search application. + # @param [String] name + # Name of the Search Application. + #
Format: searchapplications/`application_id`. + # @param [Google::Apis::CloudsearchV1::SearchApplication] search_application_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::CloudsearchV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::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_setting_searchapplication(name, search_application_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'v1/settings/{+name}', options) + command.request_representation = Google::Apis::CloudsearchV1::SearchApplication::Representation + command.request_object = search_application_object + command.response_representation = Google::Apis::CloudsearchV1::Operation::Representation + command.response_class = Google::Apis::CloudsearchV1::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 indexed item statistics aggreggated across all data sources. + # @param [Fixnum] from_date_day + # Day of month. Must be from 1 to 31 and valid for the year and month. + # @param [Fixnum] from_date_month + # Month of date. Must be from 1 to 12. + # @param [Fixnum] from_date_year + # Year of date. Must be from 1 to 9999. + # @param [Fixnum] to_date_day + # Day of month. Must be from 1 to 31 and valid for the year and month. + # @param [Fixnum] to_date_month + # Month of date. Must be from 1 to 12. + # @param [Fixnum] to_date_year + # Year of date. Must be from 1 to 9999. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::CloudsearchV1::GetCustomerIndexStatsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::GetCustomerIndexStatsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_stat_index(from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/stats/index', options) + command.response_representation = Google::Apis::CloudsearchV1::GetCustomerIndexStatsResponse::Representation + command.response_class = Google::Apis::CloudsearchV1::GetCustomerIndexStatsResponse + command.query['fromDate.day'] = from_date_day unless from_date_day.nil? + command.query['fromDate.month'] = from_date_month unless from_date_month.nil? + command.query['fromDate.year'] = from_date_year unless from_date_year.nil? + command.query['toDate.day'] = to_date_day unless to_date_day.nil? + command.query['toDate.month'] = to_date_month unless to_date_month.nil? + command.query['toDate.year'] = to_date_year unless to_date_year.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 indexed item statistics for a single data source. + # @param [String] name + # The resource id of the data source to retrieve statistics for, + # in the following format: "datasources/`source_id`" + # @param [Fixnum] from_date_day + # Day of month. Must be from 1 to 31 and valid for the year and month. + # @param [Fixnum] from_date_month + # Month of date. Must be from 1 to 12. + # @param [Fixnum] from_date_year + # Year of date. Must be from 1 to 9999. + # @param [Fixnum] to_date_day + # Day of month. Must be from 1 to 31 and valid for the year and month. + # @param [Fixnum] to_date_month + # Month of date. Must be from 1 to 12. + # @param [Fixnum] to_date_year + # Year of date. Must be from 1 to 9999. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::CloudsearchV1::GetDataSourceIndexStatsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::GetDataSourceIndexStatsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_stat_index_datasource(name, from_date_day: nil, from_date_month: nil, from_date_year: nil, to_date_day: nil, to_date_month: nil, to_date_year: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/stats/index/{+name}', options) + command.response_representation = Google::Apis::CloudsearchV1::GetDataSourceIndexStatsResponse::Representation + command.response_class = Google::Apis::CloudsearchV1::GetDataSourceIndexStatsResponse + command.params['name'] = name unless name.nil? + command.query['fromDate.day'] = from_date_day unless from_date_day.nil? + command.query['fromDate.month'] = from_date_month unless from_date_month.nil? + command.query['fromDate.year'] = from_date_year unless from_date_year.nil? + command.query['toDate.day'] = to_date_day unless to_date_day.nil? + command.query['toDate.month'] = to_date_month unless to_date_month.nil? + command.query['toDate.year'] = to_date_year unless to_date_year.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/cloudtasks_v2beta2.rb b/generated/google/apis/cloudtasks_v2beta2.rb index 85b180b10..6a95761a3 100644 --- a/generated/google/apis/cloudtasks_v2beta2.rb +++ b/generated/google/apis/cloudtasks_v2beta2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/tasks/ module CloudtasksV2beta2 VERSION = 'V2beta2' - REVISION = '20180731' + REVISION = '20181022' # 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 86e1d4af8..4dc1d68a2 100644 --- a/generated/google/apis/cloudtasks_v2beta2/classes.rb +++ b/generated/google/apis/cloudtasks_v2beta2/classes.rb @@ -65,6 +65,11 @@ module Google # and how routing is affected by # [dispatch files](https://cloud.google.com/appengine/docs/python/config/ # dispatchref). + # Traffic is encrypted during transport and never leaves Google datacenters. + # Because this traffic is carried over a communication mechanism internal to + # Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). + # The request to the handler, however, will appear to have used the HTTP + # protocol. # The AppEngineRouting used to construct the URL that the task is # delivered to can be set at the queue-level or task-level: # * If set, @@ -75,6 +80,15 @@ module Google # The `url` that the task will be sent to is: # * `url =` host `+` # relative_url + # Tasks can be dispatched to secure app handlers, unsecure app handlers, and + # URIs restricted with + # [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/ + # config/appref). + # Because tasks are not run as any user, they cannot be dispatched to URIs + # restricted with + # [`login: required`](https://cloud.google.com/appengine/docs/standard/python/ + # config/appref) + # Task dispatches also do not follow redirects. # The task attempt has succeeded if the app's request handler returns # an HTTP response code in the range [`200` - `299`]. `503` is # considered an App Engine system error instead of an application @@ -86,6 +100,8 @@ module Google include Google::Apis::Core::Hashable # App Engine Routing. + # Defines routing characteristics specific to App Engine - service, version, + # and instance. # For more information about services, versions, and instances see # [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an- # overview-of-app-engine), @@ -198,6 +214,8 @@ module Google include Google::Apis::Core::Hashable # App Engine Routing. + # Defines routing characteristics specific to App Engine - service, version, + # and instance. # For more information about services, versions, and instances see # [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an- # overview-of-app-engine), @@ -222,6 +240,8 @@ module Google end # App Engine Routing. + # Defines routing characteristics specific to App Engine - service, version, + # and instance. # For more information about services, versions, and instances see # [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an- # overview-of-app-engine), @@ -1552,6 +1572,11 @@ module Google # and how routing is affected by # [dispatch files](https://cloud.google.com/appengine/docs/python/config/ # dispatchref). + # Traffic is encrypted during transport and never leaves Google datacenters. + # Because this traffic is carried over a communication mechanism internal to + # Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). + # The request to the handler, however, will appear to have used the HTTP + # protocol. # The AppEngineRouting used to construct the URL that the task is # delivered to can be set at the queue-level or task-level: # * If set, @@ -1562,6 +1587,15 @@ module Google # The `url` that the task will be sent to is: # * `url =` host `+` # relative_url + # Tasks can be dispatched to secure app handlers, unsecure app handlers, and + # URIs restricted with + # [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/ + # config/appref). + # Because tasks are not run as any user, they cannot be dispatched to URIs + # restricted with + # [`login: required`](https://cloud.google.com/appengine/docs/standard/python/ + # config/appref) + # Task dispatches also do not follow redirects. # The task attempt has succeeded if the app's request handler returns # an HTTP response code in the range [`200` - `299`]. `503` is # considered an App Engine system error instead of an application diff --git a/generated/google/apis/cloudtasks_v2beta3.rb b/generated/google/apis/cloudtasks_v2beta3.rb index 99fd6a101..d40e0b03b 100644 --- a/generated/google/apis/cloudtasks_v2beta3.rb +++ b/generated/google/apis/cloudtasks_v2beta3.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/tasks/ module CloudtasksV2beta3 VERSION = 'V2beta3' - REVISION = '20180830' + REVISION = '20181022' # 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_v2beta3/classes.rb b/generated/google/apis/cloudtasks_v2beta3/classes.rb index fb11f8ab4..cb371d41a 100644 --- a/generated/google/apis/cloudtasks_v2beta3/classes.rb +++ b/generated/google/apis/cloudtasks_v2beta3/classes.rb @@ -37,16 +37,8 @@ module Google include Google::Apis::Core::Hashable # App Engine Routing. - # Specifies the target URI. Since this target type dispatches tasks to secure - # app handlers, unsecure app handlers, and URIs restricted with - # [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/ - # config/appref) - # the protocol (for example, HTTP or HTTPS) cannot be explictly specified. - # Task dispatches do not follow redirects and cannot target URI paths - # restricted with - # [`login: required`](https://cloud.google.com/appengine/docs/standard/python/ - # config/appref) - # because tasks are not run as any user. + # Defines routing characteristics specific to App Engine - service, version, + # and instance. # For more information about services, versions, and instances see # [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an- # overview-of-app-engine), @@ -88,6 +80,11 @@ module Google # and how routing is affected by # [dispatch files](https://cloud.google.com/appengine/docs/python/config/ # dispatchref). + # Traffic is encrypted during transport and never leaves Google datacenters. + # Because this traffic is carried over a communication mechanism internal to + # Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). + # The request to the handler, however, will appear to have used the HTTP + # protocol. # The AppEngineRouting used to construct the URL that the task is # delivered to can be set at the queue-level or task-level: # * If set, @@ -98,6 +95,15 @@ module Google # The `url` that the task will be sent to is: # * `url =` host `+` # relative_uri + # Tasks can be dispatched to secure app handlers, unsecure app handlers, and + # URIs restricted with + # [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/ + # config/appref). + # Because tasks are not run as any user, they cannot be dispatched to URIs + # restricted with + # [`login: required`](https://cloud.google.com/appengine/docs/standard/python/ + # config/appref) + # Task dispatches also do not follow redirects. # The task attempt has succeeded if the app's request handler returns # an HTTP response code in the range [`200` - `299`]. `503` is # considered an App Engine system error instead of an application @@ -109,16 +115,8 @@ module Google include Google::Apis::Core::Hashable # App Engine Routing. - # Specifies the target URI. Since this target type dispatches tasks to secure - # app handlers, unsecure app handlers, and URIs restricted with - # [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/ - # config/appref) - # the protocol (for example, HTTP or HTTPS) cannot be explictly specified. - # Task dispatches do not follow redirects and cannot target URI paths - # restricted with - # [`login: required`](https://cloud.google.com/appengine/docs/standard/python/ - # config/appref) - # because tasks are not run as any user. + # Defines routing characteristics specific to App Engine - service, version, + # and instance. # For more information about services, versions, and instances see # [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an- # overview-of-app-engine), @@ -215,16 +213,8 @@ module Google end # App Engine Routing. - # Specifies the target URI. Since this target type dispatches tasks to secure - # app handlers, unsecure app handlers, and URIs restricted with - # [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/ - # config/appref) - # the protocol (for example, HTTP or HTTPS) cannot be explictly specified. - # Task dispatches do not follow redirects and cannot target URI paths - # restricted with - # [`login: required`](https://cloud.google.com/appengine/docs/standard/python/ - # config/appref) - # because tasks are not run as any user. + # Defines routing characteristics specific to App Engine - service, version, + # and instance. # For more information about services, versions, and instances see # [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an- # overview-of-app-engine), @@ -1258,6 +1248,11 @@ module Google # and how routing is affected by # [dispatch files](https://cloud.google.com/appengine/docs/python/config/ # dispatchref). + # Traffic is encrypted during transport and never leaves Google datacenters. + # Because this traffic is carried over a communication mechanism internal to + # Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). + # The request to the handler, however, will appear to have used the HTTP + # protocol. # The AppEngineRouting used to construct the URL that the task is # delivered to can be set at the queue-level or task-level: # * If set, @@ -1268,6 +1263,15 @@ module Google # The `url` that the task will be sent to is: # * `url =` host `+` # relative_uri + # Tasks can be dispatched to secure app handlers, unsecure app handlers, and + # URIs restricted with + # [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/ + # config/appref). + # Because tasks are not run as any user, they cannot be dispatched to URIs + # restricted with + # [`login: required`](https://cloud.google.com/appengine/docs/standard/python/ + # config/appref) + # Task dispatches also do not follow redirects. # The task attempt has succeeded if the app's request handler returns # an HTTP response code in the range [`200` - `299`]. `503` is # considered an App Engine system error instead of an application diff --git a/generated/google/apis/composer_v1beta1.rb b/generated/google/apis/composer_v1beta1.rb index 3cccc7b05..d5d99d99c 100644 --- a/generated/google/apis/composer_v1beta1.rb +++ b/generated/google/apis/composer_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/composer/ module ComposerV1beta1 VERSION = 'V1beta1' - REVISION = '20181001' + REVISION = '20181019' # 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/composer_v1beta1/classes.rb b/generated/google/apis/composer_v1beta1/classes.rb index 681a1e4f0..313b4e983 100644 --- a/generated/google/apis/composer_v1beta1/classes.rb +++ b/generated/google/apis/composer_v1beta1/classes.rb @@ -533,8 +533,7 @@ module Google # Immutable. The version of the software running in the environment. # This encapsulates both the version of Cloud Composer functionality and the # version of Apache Airflow. It must match the regular expression - # `composer-([0-9]+\.[0-9]+(\.[0-9]+)?|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*) - # ?`. + # `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. # When used as input, the server will also check if the provided version is # supported and deny the creation request for an unsupported version. # The Cloud Composer portion of the version is a @@ -548,16 +547,14 @@ module Google # Apache Airflow repository # [release name](https://github.com/apache/incubator-airflow/releases). # Supported values for input are: - # * `composer-latest-airflow-latest` # * `composer-latest-airflow-1.10.0` # * `composer-latest-airflow-1.9.0` # * `composer-latest-airflow-1.10` # * `composer-latest-airflow-1.9` - # * `composer-1.1.1-airflow-latest` - # * `composer-1.1.1-airflow-1.10.0` - # * `composer-1.1.1-airflow-1.9.0` - # * `composer-1.1.1-airflow-1.10` - # * `composer-1.1.1-airflow-1.9` + # * `composer-1.3.0-airflow-1.10.0` + # * `composer-1.3.0-airflow-1.9.0` + # * `composer-1.3.0-airflow-1.10` + # * `composer-1.3.0-airflow-1.9` # See also [Release Notes](/composer/docs/release-notes). # Corresponds to the JSON property `imageVersion` # @return [String] diff --git a/generated/google/apis/compute_alpha.rb b/generated/google/apis/compute_alpha.rb index 99f056435..86f348c01 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 = '20180916' + REVISION = '20181017' # 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.rb b/generated/google/apis/compute_beta.rb index 2fb1904dc..a83afffd0 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 = '20180916' + REVISION = '20181017' # 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.rb b/generated/google/apis/compute_v1.rb index 15efacd53..395e5cfa7 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 = '20180916' + REVISION = '20181017' # 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/content_v2.rb b/generated/google/apis/content_v2.rb index 1b43721aa..e7831cd59 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 = '20181016' + REVISION = '20181029' # 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 b99a746d1..0785190cd 100644 --- a/generated/google/apis/content_v2/classes.rb +++ b/generated/google/apis/content_v2/classes.rb @@ -1569,6 +1569,70 @@ module Google end end + # + class CustomAttribute + include Google::Apis::Core::Hashable + + # The name of the attribute. Underscores will be replaced by spaces upon + # insertion. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The type of the attribute. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # Free-form unit of the attribute. Unit can only be used for values of type int, + # float, or price. + # Corresponds to the JSON property `unit` + # @return [String] + attr_accessor :unit + + # The value of the attribute. + # 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) + @type = args[:type] if args.key?(:type) + @unit = args[:unit] if args.key?(:unit) + @value = args[:value] if args.key?(:value) + end + end + + # + class CustomGroup + include Google::Apis::Core::Hashable + + # The sub-attributes. + # Corresponds to the JSON property `attributes` + # @return [Array] + attr_accessor :attributes + + # The name of the group. Underscores will be replaced by spaces upon insertion. + # 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) + @attributes = args[:attributes] if args.key?(:attributes) + @name = args[:name] if args.key?(:name) + end + end + # class CustomerReturnReason include Google::Apis::Core::Hashable @@ -2764,6 +2828,11 @@ module Google # @return [Google::Apis::ContentV2::Installment] attr_accessor :installment + # The instore product location. Supported only for local products. + # Corresponds to the JSON property `instoreProductLocation` + # @return [String] + attr_accessor :instore_product_location + # Identifies what kind of resource this is. Value: the fixed string "content# # inventory". # Corresponds to the JSON property `kind` @@ -2825,6 +2894,7 @@ module Google @custom_label3 = args[:custom_label3] if args.key?(:custom_label3) @custom_label4 = args[:custom_label4] if args.key?(:custom_label4) @installment = args[:installment] if args.key?(:installment) + @instore_product_location = args[:instore_product_location] if args.key?(:instore_product_location) @kind = args[:kind] if args.key?(:kind) @loyalty_points = args[:loyalty_points] if args.key?(:loyalty_points) @pickup = args[:pickup] if args.key?(:pickup) @@ -3031,6 +3101,11 @@ module Google # @return [Google::Apis::ContentV2::Installment] attr_accessor :installment + # The instore product location. Supported only for local products. + # Corresponds to the JSON property `instoreProductLocation` + # @return [String] + attr_accessor :instore_product_location + # Loyalty points that users receive after purchasing the item. Japan only. # Corresponds to the JSON property `loyaltyPoints` # @return [Google::Apis::ContentV2::LoyaltyPoints] @@ -3086,6 +3161,7 @@ module Google @custom_label3 = args[:custom_label3] if args.key?(:custom_label3) @custom_label4 = args[:custom_label4] if args.key?(:custom_label4) @installment = args[:installment] if args.key?(:installment) + @instore_product_location = args[:instore_product_location] if args.key?(:instore_product_location) @loyalty_points = args[:loyalty_points] if args.key?(:loyalty_points) @pickup = args[:pickup] if args.key?(:pickup) @price = args[:price] if args.key?(:price) @@ -4485,6 +4561,11 @@ module Google # @return [String] attr_accessor :content_language + # Associated fees at order creation time. + # Corresponds to the JSON property `fees` + # @return [Array] + attr_accessor :fees + # Global Trade Item Number (GTIN) of the item. # Corresponds to the JSON property `gtin` # @return [String] @@ -4552,6 +4633,7 @@ module Google @channel = args[:channel] if args.key?(:channel) @condition = args[:condition] if args.key?(:condition) @content_language = args[:content_language] if args.key?(:content_language) + @fees = args[:fees] if args.key?(:fees) @gtin = args[:gtin] if args.key?(:gtin) @id = args[:id] if args.key?(:id) @image_link = args[:image_link] if args.key?(:image_link) @@ -4566,6 +4648,37 @@ module Google end end + # + class OrderLineItemProductFee + include Google::Apis::Core::Hashable + + # Amount of the fee. + # Corresponds to the JSON property `amount` + # @return [Google::Apis::ContentV2::Price] + attr_accessor :amount + + # Case-insensitive fee ID. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Name of the fee. + # 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) + @amount = args[:amount] if args.key?(:amount) + @id = args[:id] if args.key?(:id) + @name = args[:name] if args.key?(:name) + end + end + # class OrderLineItemProductVariantAttribute include Google::Apis::Core::Hashable @@ -8427,12 +8540,12 @@ module Google # "name": "size type", "type": "text", "value": "regular" `). This is useful # for submitting attributes not explicitly exposed by the API. # Corresponds to the JSON property `customAttributes` - # @return [Array] + # @return [Array] attr_accessor :custom_attributes # A list of custom (merchant-provided) custom attribute groups. # Corresponds to the JSON property `customGroups` - # @return [Array] + # @return [Array] attr_accessor :custom_groups # Custom label 0 for custom grouping of items in a Shopping campaign. @@ -8874,70 +8987,6 @@ module Google end end - # - class ProductCustomAttribute - include Google::Apis::Core::Hashable - - # The name of the attribute. Underscores will be replaced by spaces upon - # insertion. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The type of the attribute. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # Free-form unit of the attribute. Unit can only be used for values of type int, - # float, or price. - # Corresponds to the JSON property `unit` - # @return [String] - attr_accessor :unit - - # The value of the attribute. - # 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) - @type = args[:type] if args.key?(:type) - @unit = args[:unit] if args.key?(:unit) - @value = args[:value] if args.key?(:value) - end - end - - # - class ProductCustomGroup - include Google::Apis::Core::Hashable - - # The sub-attributes. - # Corresponds to the JSON property `attributes` - # @return [Array] - attr_accessor :attributes - - # The name of the group. Underscores will be replaced by spaces upon insertion. - # 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) - @attributes = args[:attributes] if args.key?(:attributes) - @name = args[:name] if args.key?(:name) - end - end - # class ProductDestination include Google::Apis::Core::Hashable diff --git a/generated/google/apis/content_v2/representations.rb b/generated/google/apis/content_v2/representations.rb index 87c64f0d7..4a3b2c9b5 100644 --- a/generated/google/apis/content_v2/representations.rb +++ b/generated/google/apis/content_v2/representations.rb @@ -268,6 +268,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class CustomAttribute + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class CustomGroup + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class CustomerReturnReason class Representation < Google::Apis::Core::JsonRepresentation; end @@ -688,6 +700,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class OrderLineItemProductFee + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class OrderLineItemProductVariantAttribute class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1294,18 +1312,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ProductCustomAttribute - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ProductCustomGroup - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class ProductDestination class Representation < Google::Apis::Core::JsonRepresentation; end @@ -2044,6 +2050,25 @@ module Google end end + class CustomAttribute + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :type, as: 'type' + property :unit, as: 'unit' + property :value, as: 'value' + end + end + + class CustomGroup + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :attributes, as: 'attributes', class: Google::Apis::ContentV2::CustomAttribute, decorator: Google::Apis::ContentV2::CustomAttribute::Representation + + property :name, as: 'name' + end + end + class CustomerReturnReason # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2370,6 +2395,7 @@ module Google property :custom_label4, as: 'customLabel4' property :installment, as: 'installment', class: Google::Apis::ContentV2::Installment, decorator: Google::Apis::ContentV2::Installment::Representation + property :instore_product_location, as: 'instoreProductLocation' property :kind, as: 'kind' property :loyalty_points, as: 'loyaltyPoints', class: Google::Apis::ContentV2::LoyaltyPoints, decorator: Google::Apis::ContentV2::LoyaltyPoints::Representation @@ -2443,6 +2469,7 @@ module Google property :custom_label4, as: 'customLabel4' property :installment, as: 'installment', class: Google::Apis::ContentV2::Installment, decorator: Google::Apis::ContentV2::Installment::Representation + property :instore_product_location, as: 'instoreProductLocation' property :loyalty_points, as: 'loyaltyPoints', class: Google::Apis::ContentV2::LoyaltyPoints, decorator: Google::Apis::ContentV2::LoyaltyPoints::Representation property :pickup, as: 'pickup', class: Google::Apis::ContentV2::InventoryPickup, decorator: Google::Apis::ContentV2::InventoryPickup::Representation @@ -2858,6 +2885,8 @@ module Google property :channel, as: 'channel' property :condition, as: 'condition' property :content_language, as: 'contentLanguage' + collection :fees, as: 'fees', class: Google::Apis::ContentV2::OrderLineItemProductFee, decorator: Google::Apis::ContentV2::OrderLineItemProductFee::Representation + property :gtin, as: 'gtin' property :id, as: 'id' property :image_link, as: 'imageLink' @@ -2874,6 +2903,16 @@ module Google end end + class OrderLineItemProductFee + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :amount, as: 'amount', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation + + property :id, as: 'id' + property :name, as: 'name' + end + end + class OrderLineItemProductVariantAttribute # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -3959,9 +3998,9 @@ module Google property :content_language, as: 'contentLanguage' property :cost_of_goods_sold, as: 'costOfGoodsSold', class: Google::Apis::ContentV2::Price, decorator: Google::Apis::ContentV2::Price::Representation - collection :custom_attributes, as: 'customAttributes', class: Google::Apis::ContentV2::ProductCustomAttribute, decorator: Google::Apis::ContentV2::ProductCustomAttribute::Representation + collection :custom_attributes, as: 'customAttributes', class: Google::Apis::ContentV2::CustomAttribute, decorator: Google::Apis::ContentV2::CustomAttribute::Representation - collection :custom_groups, as: 'customGroups', class: Google::Apis::ContentV2::ProductCustomGroup, decorator: Google::Apis::ContentV2::ProductCustomGroup::Representation + collection :custom_groups, as: 'customGroups', class: Google::Apis::ContentV2::CustomGroup, decorator: Google::Apis::ContentV2::CustomGroup::Representation property :custom_label0, as: 'customLabel0' property :custom_label1, as: 'customLabel1' @@ -4049,25 +4088,6 @@ module Google end end - class ProductCustomAttribute - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :type, as: 'type' - property :unit, as: 'unit' - property :value, as: 'value' - end - end - - class ProductCustomGroup - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :attributes, as: 'attributes', class: Google::Apis::ContentV2::ProductCustomAttribute, decorator: Google::Apis::ContentV2::ProductCustomAttribute::Representation - - property :name, as: 'name' - end - end - class ProductDestination # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/dataflow_v1b3.rb b/generated/google/apis/dataflow_v1b3.rb index 843d563e1..67e1014c5 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 = '20180926' + REVISION = '20181016' # 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 255387037..6331039cc 100644 --- a/generated/google/apis/dataflow_v1b3/classes.rb +++ b/generated/google/apis/dataflow_v1b3/classes.rb @@ -1810,6 +1810,16 @@ module Google # @return [Array] attr_accessor :stage_states + # The timestamp when the job was started (transitioned to JOB_STATE_PENDING). + # Flexible resource scheduling jobs are started with some delay after job + # creation, so start_time is unset before start and is updated when the + # job is started by the Cloud Dataflow service. For other jobs, start_time + # always equals to create_time and is immutable and set by the Cloud Dataflow + # service. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + # The top-level steps that constitute the entire job. # Corresponds to the JSON property `steps` # @return [Array] @@ -1862,6 +1872,7 @@ module Google @replaced_by_job_id = args[:replaced_by_job_id] if args.key?(:replaced_by_job_id) @requested_state = args[:requested_state] if args.key?(:requested_state) @stage_states = args[:stage_states] if args.key?(:stage_states) + @start_time = args[:start_time] if args.key?(:start_time) @steps = args[:steps] if args.key?(:steps) @temp_files = args[:temp_files] if args.key?(:temp_files) @transform_name_mapping = args[:transform_name_mapping] if args.key?(:transform_name_mapping) @@ -4234,6 +4245,31 @@ module Google end end + # Streaming appliance snapshot configuration. + class StreamingApplianceSnapshotConfig + include Google::Apis::Core::Hashable + + # Indicates which endpoint is used to import appliance state. + # Corresponds to the JSON property `importStateEndpoint` + # @return [String] + attr_accessor :import_state_endpoint + + # If set, indicates the snapshot id for the snapshot being performed. + # Corresponds to the JSON property `snapshotId` + # @return [String] + attr_accessor :snapshot_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @import_state_endpoint = args[:import_state_endpoint] if args.key?(:import_state_endpoint) + @snapshot_id = args[:snapshot_id] if args.key?(:snapshot_id) + end + end + # Configuration information for a single streaming computation. class StreamingComputationConfig include Google::Apis::Core::Hashable @@ -4386,6 +4422,11 @@ module Google # @return [Fixnum] attr_accessor :receive_work_port + # Streaming appliance snapshot configuration. + # Corresponds to the JSON property `snapshotConfig` + # @return [Google::Apis::DataflowV1b3::StreamingApplianceSnapshotConfig] + attr_accessor :snapshot_config + # Global topology of the streaming Dataflow job, including all # computations and their sharded locations. # Corresponds to the JSON property `streamingComputationTopology` @@ -4406,6 +4447,7 @@ module Google def update!(**args) @drain = args[:drain] if args.key?(:drain) @receive_work_port = args[:receive_work_port] if args.key?(:receive_work_port) + @snapshot_config = args[:snapshot_config] if args.key?(:snapshot_config) @streaming_computation_topology = args[:streaming_computation_topology] if args.key?(:streaming_computation_topology) @worker_harness_port = args[:worker_harness_port] if args.key?(:worker_harness_port) end diff --git a/generated/google/apis/dataflow_v1b3/representations.rb b/generated/google/apis/dataflow_v1b3/representations.rb index fa4de7b8f..65b744d16 100644 --- a/generated/google/apis/dataflow_v1b3/representations.rb +++ b/generated/google/apis/dataflow_v1b3/representations.rb @@ -670,6 +670,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class StreamingApplianceSnapshotConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class StreamingComputationConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1308,6 +1314,7 @@ module Google property :requested_state, as: 'requestedState' collection :stage_states, as: 'stageStates', class: Google::Apis::DataflowV1b3::ExecutionStageState, decorator: Google::Apis::DataflowV1b3::ExecutionStageState::Representation + property :start_time, as: 'startTime' collection :steps, as: 'steps', class: Google::Apis::DataflowV1b3::Step, decorator: Google::Apis::DataflowV1b3::Step::Representation collection :temp_files, as: 'tempFiles' @@ -1975,6 +1982,14 @@ module Google end end + class StreamingApplianceSnapshotConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :import_state_endpoint, as: 'importStateEndpoint' + property :snapshot_id, as: 'snapshotId' + end + end + class StreamingComputationConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2022,6 +2037,8 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :drain, as: 'drain' property :receive_work_port, as: 'receiveWorkPort' + property :snapshot_config, as: 'snapshotConfig', class: Google::Apis::DataflowV1b3::StreamingApplianceSnapshotConfig, decorator: Google::Apis::DataflowV1b3::StreamingApplianceSnapshotConfig::Representation + property :streaming_computation_topology, as: 'streamingComputationTopology', class: Google::Apis::DataflowV1b3::TopologyConfig, decorator: Google::Apis::DataflowV1b3::TopologyConfig::Representation property :worker_harness_port, as: 'workerHarnessPort' diff --git a/generated/google/apis/dataproc_v1.rb b/generated/google/apis/dataproc_v1.rb index b0f799072..701cc345b 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 = '20180928' + REVISION = '20181019' # 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/classes.rb b/generated/google/apis/dataproc_v1/classes.rb index f38e90710..111941d5d 100644 --- a/generated/google/apis/dataproc_v1/classes.rb +++ b/generated/google/apis/dataproc_v1/classes.rb @@ -2267,35 +2267,35 @@ module Google # to appear in at most one parameter's list of field paths.A field path is # similar in syntax to a google.protobuf.FieldMask. For example, a field path # that references the zone field of a workflow template's cluster selector would - # be specified as placement.clusterSelector.zone.Also, field paths - # can reference fields using the following syntax: - # Values in maps can be referenced by key. Examples
+ # be specified as placement.clusterSelector.zone.Also, field paths can reference + # fields using the following syntax: + # Values in maps can be referenced by key: # labels'key' # placement.clusterSelector.clusterLabels'key' # placement.managedCluster.labels'key' # placement.clusterSelector.clusterLabels'key' - # jobsstep-id.labels'key' - # Jobs in the jobs list can be referenced by step-id. Examples:
- # jobsstep-id.hadoopJob.mainJarFileUri - # jobsstep-id.hiveJob.queryFileUri - # jobsstep-id.pySparkJob.mainPythonFileUri - # jobsstep-id.hadoopJob.jarFileUris0 - # jobsstep-id.hadoopJob.archiveUris0 - # jobsstep-id.hadoopJob.fileUris0 - # jobsstep-id.pySparkJob.pythonFileUris0 - # Items in repeated fields can be referenced by a zero-based index. Example:
- # jobsstep-id.sparkJob.args0 + # jobs'step-id'.labels'key' + # Jobs in the jobs list can be referenced by step-id: + # jobs'step-id'.hadoopJob.mainJarFileUri + # jobs'step-id'.hiveJob.queryFileUri + # jobs'step-id'.pySparkJob.mainPythonFileUri + # jobs'step-id'.hadoopJob.jarFileUris0 + # jobs'step-id'.hadoopJob.archiveUris0 + # jobs'step-id'.hadoopJob.fileUris0 + # jobs'step-id'.pySparkJob.pythonFileUris0 + # Items in repeated fields can be referenced by a zero-based index: + # jobs'step-id'.sparkJob.args0 # Other examples: - # jobsstep-id.hadoopJob.properties'key' - # jobsstep-id.hadoopJob.args0 - # jobsstep-id.hiveJob.scriptVariables'key' - # jobsstep-id.hadoopJob.mainJarFileUri + # jobs'step-id'.hadoopJob.properties'key' + # jobs'step-id'.hadoopJob.args0 + # jobs'step-id'.hiveJob.scriptVariables'key' + # jobs'step-id'.hadoopJob.mainJarFileUri # placement.clusterSelector.zoneIt may not be possible to parameterize maps and # repeated fields in their entirety since only individual map values and # individual items in repeated fields can be referenced. For example, the # following field paths are invalid: # placement.clusterSelector.clusterLabels - # jobsstep-id.sparkJob.args + # jobs'step-id'.sparkJob.args # Corresponds to the JSON property `fields` # @return [Array] attr_accessor :fields diff --git a/generated/google/apis/dataproc_v1beta2.rb b/generated/google/apis/dataproc_v1beta2.rb index 93f2f5f2a..a1f2e5b77 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 = '20180928' + REVISION = '20181019' # 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 8c24006ae..c5a87c2ae 100644 --- a/generated/google/apis/dataproc_v1beta2/classes.rb +++ b/generated/google/apis/dataproc_v1beta2/classes.rb @@ -2328,35 +2328,35 @@ module Google # to appear in at most one parameter's list of field paths.A field path is # similar in syntax to a google.protobuf.FieldMask. For example, a field path # that references the zone field of a workflow template's cluster selector would - # be specified as placement.clusterSelector.zone.Also, field paths - # can reference fields using the following syntax: - # Values in maps can be referenced by key. Examples
+ # be specified as placement.clusterSelector.zone.Also, field paths can reference + # fields using the following syntax: + # Values in maps can be referenced by key: # labels'key' # placement.clusterSelector.clusterLabels'key' # placement.managedCluster.labels'key' # placement.clusterSelector.clusterLabels'key' - # jobsstep-id.labels'key' - # Jobs in the jobs list can be referenced by step-id. Examples:
- # jobsstep-id.hadoopJob.mainJarFileUri - # jobsstep-id.hiveJob.queryFileUri - # jobsstep-id.pySparkJob.mainPythonFileUri - # jobsstep-id.hadoopJob.jarFileUris0 - # jobsstep-id.hadoopJob.archiveUris0 - # jobsstep-id.hadoopJob.fileUris0 - # jobsstep-id.pySparkJob.pythonFileUris0 - # Items in repeated fields can be referenced by a zero-based index. Example:
- # jobsstep-id.sparkJob.args0 + # jobs'step-id'.labels'key' + # Jobs in the jobs list can be referenced by step-id: + # jobs'step-id'.hadoopJob.mainJarFileUri + # jobs'step-id'.hiveJob.queryFileUri + # jobs'step-id'.pySparkJob.mainPythonFileUri + # jobs'step-id'.hadoopJob.jarFileUris0 + # jobs'step-id'.hadoopJob.archiveUris0 + # jobs'step-id'.hadoopJob.fileUris0 + # jobs'step-id'.pySparkJob.pythonFileUris0 + # Items in repeated fields can be referenced by a zero-based index: + # jobs'step-id'.sparkJob.args0 # Other examples: - # jobsstep-id.hadoopJob.properties'key' - # jobsstep-id.hadoopJob.args0 - # jobsstep-id.hiveJob.scriptVariables'key' - # jobsstep-id.hadoopJob.mainJarFileUri + # jobs'step-id'.hadoopJob.properties'key' + # jobs'step-id'.hadoopJob.args0 + # jobs'step-id'.hiveJob.scriptVariables'key' + # jobs'step-id'.hadoopJob.mainJarFileUri # placement.clusterSelector.zoneIt may not be possible to parameterize maps and # repeated fields in their entirety since only individual map values and # individual items in repeated fields can be referenced. For example, the # following field paths are invalid: # placement.clusterSelector.clusterLabels - # jobsstep-id.sparkJob.args + # jobs'step-id'.sparkJob.args # Corresponds to the JSON property `fields` # @return [Array] attr_accessor :fields diff --git a/generated/google/apis/dfareporting_v2_8.rb b/generated/google/apis/dfareporting_v2_8.rb deleted file mode 100644 index 0d1f394e9..000000000 --- a/generated/google/apis/dfareporting_v2_8.rb +++ /dev/null @@ -1,40 +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/dfareporting_v2_8/service.rb' -require 'google/apis/dfareporting_v2_8/classes.rb' -require 'google/apis/dfareporting_v2_8/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 DfareportingV2_8 - VERSION = 'V2_8' - REVISION = '20180830' - - # 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_v2_8/classes.rb b/generated/google/apis/dfareporting_v2_8/classes.rb deleted file mode 100644 index b1090b037..000000000 --- a/generated/google/apis/dfareporting_v2_8/classes.rb +++ /dev/null @@ -1,12043 +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 DfareportingV2_8 - - # Contains properties of a Campaign Manager 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::DfareportingV2_8::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 Campaign Manager 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 Campaign Manager 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::DfareportingV2_8::ObjectFilter] - attr_accessor :advertiser_filter - - # Object Filter. - # Corresponds to the JSON property `campaignFilter` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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. This is a read-only field. - # 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::DfareportingV2_8::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 Campaign Manager 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::DfareportingV2_8::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::DfareportingV2_8::DimensionValue] - attr_accessor :campaign_id_dimension_value - - # Click-through URL - # Corresponds to the JSON property `clickThroughUrl` - # @return [Google::Apis::DfareportingV2_8::ClickThroughUrl] - attr_accessor :click_through_url - - # Click Through URL Suffix settings. - # Corresponds to the JSON property `clickThroughUrlSuffixProperties` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::CreativeRotation] - attr_accessor :creative_rotation - - # Day Part Targeting. - # Corresponds to the JSON property `dayPartTargeting` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DefaultClickThroughEventTagProperties] - attr_accessor :default_click_through_event_tag_properties - - # Delivery Schedule. - # Corresponds to the JSON property `deliverySchedule` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::DimensionValue] - attr_accessor :id_dimension_value - - # Key Value Targeting Expression. - # Corresponds to the JSON property `keyValueTargetingExpression` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::LanguageTargeting] - attr_accessor :language_targeting - - # Modification timestamp. - # Corresponds to the JSON property `lastModifiedInfo` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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 Campaign Manager 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::DfareportingV2_8::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::DfareportingV2_8::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 - - # 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 Campaign Manager 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::DfareportingV2_8::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::DfareportingV2_8::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 Campaign Manager 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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::DefaultClickThroughEventTagProperties] - attr_accessor :default_click_through_event_tag_properties - - # 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::DfareportingV2_8::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::DfareportingV2_8::LastModifiedInfo] - attr_accessor :last_modified_info - - # Lookback configuration settings. - # Corresponds to the JSON property `lookbackConfiguration` - # @return [Google::Apis::DfareportingV2_8::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) - @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 - - # 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 - - # Parameter value for the specified click tag. This field contains a click- - # through url. - # 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) - @event_name = args[:event_name] if args.key?(:event_name) - @name = args[:name] if args.key?(:name) - @value = args[:value] if args.key?(:value) - 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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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 for backup image. Applicable to the following creative types: - # 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] - 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 Campaign Manager 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::DfareportingV2_8::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 video creative. - # 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::DfareportingV2_8::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::DfareportingV2_8::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 generated by Campaign Manager 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::DfareportingV2_8::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::DfareportingV2_8::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 - - # Video Offset - # Corresponds to the JSON property `progressOffset` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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 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::DfareportingV2_8::Size] - attr_accessor :size - - # Video Offset - # Corresponds to the JSON property `skipOffset` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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) - @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::DfareportingV2_8::CreativeAssetId] - attr_accessor :asset_identifier - - # Creative Custom Event. - # Corresponds to the JSON property `backupImageExit` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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 - # Campaign Manager. 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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::OffsetPosition] - attr_accessor :offset - - # Whether the backup asset is original or changed by the user in Campaign - # Manager. 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::DfareportingV2_8::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 Campaign Manager, such as - # Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. - # PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is - # applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. - # TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from - # PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO - # creatives. - # ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset - # videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These - # cannot be added or removed within Campaign Manager. - # 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::DfareportingV2_8::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) - @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::DfareportingV2_8::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 - # Campaign Manager. 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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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 - - # Creative Custom Event. - class CreativeCustomEvent - include Google::Apis::Core::Hashable - - # Unique ID of this event used by 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 Campaign Manager 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 - - # Exit URL of the event. This field is used only for exit events. - # Corresponds to the JSON property `exitUrl` - # @return [String] - attr_accessor :exit_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::DfareportingV2_8::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_url = args[:exit_url] if args.key?(:exit_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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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 Campaign Manager 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 - - # Google Ad Manager Settings - class DfpSettings - include Google::Apis::Core::Hashable - - # Ad Manager network code for this directory site. - # Corresponds to the JSON property `dfpNetworkCode` - # @return [String] - attr_accessor :dfp_network_code - - # Ad Manager 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 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::DfareportingV2_8::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::DfareportingV2_8::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 - - # Google Ad Manager Settings - # Corresponds to the JSON property `dfpSettings` - # @return [Google::Apis::DfareportingV2_8::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 - # Studio dynamic creatives. Use these labels instead of numeric Campaign Manager - # 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::DfareportingV2_8::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::DfareportingV2_8::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 Display & - # Video 360 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::DfareportingV2_8::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::DfareportingV2_8::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 - - # 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) - @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::DfareportingV2_8::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::DfareportingV2_8::DimensionValue] - attr_accessor :floodlight_configuration_id_dimension_value - - # 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::DfareportingV2_8::DimensionValue] - attr_accessor :id_dimension_value - - # Whether the image tag is enabled for this activity. - # Corresponds to the JSON property `imageTagEnabled` - # @return [Boolean] - attr_accessor :image_tag_enabled - alias_method :image_tag_enabled?, :image_tag_enabled - - # 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) - @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) - @image_tag_enabled = args[:image_tag_enabled] if args.key?(:image_tag_enabled) - @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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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 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::DfareportingV2_8::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::DfareportingV2_8::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 - - # Whether or not this landing page will be assigned to any ads or creatives that - # do not have a landing page assigned explicitly. Only one default landing page - # is allowed per campaign. - # Corresponds to the JSON property `default` - # @return [Boolean] - attr_accessor :default - alias_method :default?, :default - - # 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, and must be unique among landing pages of the same campaign. - # 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) - @default = args[:default] if args.key?(:default) - @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 - - # Landing Page List Response - class LandingPagesListResponse - include Google::Apis::Core::Hashable - - # Identifies what kind of resource this is. Value: the fixed string " - # dfareporting#landingPagesListResponse". - # 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 - - 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) - 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::DfareportingV2_8::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::DfareportingV2_8::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 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::DfareportingV2_8::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 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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::LastModifiedInfo] - attr_accessor :last_modified_info - - # Lookback configuration settings. - # Corresponds to the JSON property `lookbackConfiguration` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::Size] - attr_accessor :dimension - - # Offset Position. - # Corresponds to the JSON property `offset` - # @return [Google::Apis::DfareportingV2_8::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 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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::Report::CrossDimensionReachCriteria] - attr_accessor :cross_dimension_reach_criteria - - # The report's email delivery settings. - # Corresponds to the JSON property `delivery` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::Activities] - attr_accessor :activities - - # Represents a Custom Rich Media Events group. - # Corresponds to the JSON property `customRichMediaEvents` - # @return [Google::Apis::DfareportingV2_8::CustomRichMediaEvents] - attr_accessor :custom_rich_media_events - - # Represents a date range. - # Corresponds to the JSON property `dateRange` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::DateRange] - attr_accessor :date_range - - # Represents a DimensionValue resource. - # Corresponds to the JSON property `floodlightConfigId` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::Activities] - attr_accessor :activities - - # Represents a Custom Rich Media Events group. - # Corresponds to the JSON property `customRichMediaEvents` - # @return [Google::Apis::DfareportingV2_8::CustomRichMediaEvents] - attr_accessor :custom_rich_media_events - - # Represents a date range. - # Corresponds to the JSON property `dateRange` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::LookbackConfiguration] - attr_accessor :lookback_configuration - - # Tag Settings - # Corresponds to the JSON property `tagSetting` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::VideoOffset] - attr_accessor :progress_offset - - # Video Offset - # Corresponds to the JSON property `skipOffset` - # @return [Google::Apis::DfareportingV2_8::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 Campaign Manager 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::DfareportingV2_8::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::DfareportingV2_8::DimensionValue] - attr_accessor :advertiser_id_dimension_value - - # Day Part Targeting. - # Corresponds to the JSON property `dayPartTargeting` - # @return [Google::Apis::DfareportingV2_8::DayPartTargeting] - attr_accessor :day_part_targeting - - # Geographical Targeting. - # Corresponds to the JSON property `geoTargeting` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::LanguageTargeting] - attr_accessor :language_targeting - - # Remarketing List Targeting Expression. - # Corresponds to the JSON property `listTargetingExpression` - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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::DfareportingV2_8::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 - - # Skippable Settings - # Corresponds to the JSON property `skippableSettings` - # @return [Google::Apis::DfareportingV2_8::SkippableSetting] - attr_accessor :skippable_settings - - # Transcode Settings - # Corresponds to the JSON property `transcodeSettings` - # @return [Google::Apis::DfareportingV2_8::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) - @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_v2_8/representations.rb b/generated/google/apis/dfareporting_v2_8/representations.rb deleted file mode 100644 index 39feeb872..000000000 --- a/generated/google/apis/dfareporting_v2_8/representations.rb +++ /dev/null @@ -1,4311 +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 DfareportingV2_8 - - 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 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 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 LandingPagesListResponse - 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::DfareportingV2_8::ReportsConfiguration, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountPermissionGroup, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountPermission, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ObjectFilter, decorator: Google::Apis::DfareportingV2_8::ObjectFilter::Representation - - property :campaign_filter, as: 'campaignFilter', class: Google::Apis::DfareportingV2_8::ObjectFilter, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ObjectFilter, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ObjectFilter, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountUserProfile, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Account, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :click_through_url, as: 'clickThroughUrl', class: Google::Apis::DfareportingV2_8::ClickThroughUrl, decorator: Google::Apis::DfareportingV2_8::ClickThroughUrl::Representation - - property :click_through_url_suffix_properties, as: 'clickThroughUrlSuffixProperties', class: Google::Apis::DfareportingV2_8::ClickThroughUrlSuffixProperties, decorator: Google::Apis::DfareportingV2_8::ClickThroughUrlSuffixProperties::Representation - - property :comments, as: 'comments' - property :compatibility, as: 'compatibility' - property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation - - collection :creative_group_assignments, as: 'creativeGroupAssignments', class: Google::Apis::DfareportingV2_8::CreativeGroupAssignment, decorator: Google::Apis::DfareportingV2_8::CreativeGroupAssignment::Representation - - property :creative_rotation, as: 'creativeRotation', class: Google::Apis::DfareportingV2_8::CreativeRotation, decorator: Google::Apis::DfareportingV2_8::CreativeRotation::Representation - - property :day_part_targeting, as: 'dayPartTargeting', class: Google::Apis::DfareportingV2_8::DayPartTargeting, decorator: Google::Apis::DfareportingV2_8::DayPartTargeting::Representation - - property :default_click_through_event_tag_properties, as: 'defaultClickThroughEventTagProperties', class: Google::Apis::DfareportingV2_8::DefaultClickThroughEventTagProperties, decorator: Google::Apis::DfareportingV2_8::DefaultClickThroughEventTagProperties::Representation - - property :delivery_schedule, as: 'deliverySchedule', class: Google::Apis::DfareportingV2_8::DeliverySchedule, decorator: Google::Apis::DfareportingV2_8::DeliverySchedule::Representation - - property :dynamic_click_tracker, as: 'dynamicClickTracker' - property :end_time, as: 'endTime', type: DateTime - - collection :event_tag_overrides, as: 'eventTagOverrides', class: Google::Apis::DfareportingV2_8::EventTagOverride, decorator: Google::Apis::DfareportingV2_8::EventTagOverride::Representation - - property :geo_targeting, as: 'geoTargeting', class: Google::Apis::DfareportingV2_8::GeoTargeting, decorator: Google::Apis::DfareportingV2_8::GeoTargeting::Representation - - property :id, :numeric_string => true, as: 'id' - property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :key_value_targeting_expression, as: 'keyValueTargetingExpression', class: Google::Apis::DfareportingV2_8::KeyValueTargetingExpression, decorator: Google::Apis::DfareportingV2_8::KeyValueTargetingExpression::Representation - - property :kind, as: 'kind' - property :language_targeting, as: 'languageTargeting', class: Google::Apis::DfareportingV2_8::LanguageTargeting, decorator: Google::Apis::DfareportingV2_8::LanguageTargeting::Representation - - property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation - - property :name, as: 'name' - collection :placement_assignments, as: 'placementAssignments', class: Google::Apis::DfareportingV2_8::PlacementAssignment, decorator: Google::Apis::DfareportingV2_8::PlacementAssignment::Representation - - property :remarketing_list_expression, as: 'remarketingListExpression', class: Google::Apis::DfareportingV2_8::ListTargetingExpression, decorator: Google::Apis::DfareportingV2_8::ListTargetingExpression::Representation - - property :size, as: 'size', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TechnologyTargeting, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Ad, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :id, :numeric_string => true, as: 'id' - property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AdvertiserGroup, decorator: Google::Apis::DfareportingV2_8::AdvertiserGroup::Representation - - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - end - end - - class AdvertisersListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :advertisers, as: 'advertisers', class: Google::Apis::DfareportingV2_8::Advertiser, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AudienceSegment, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Browser, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AdBlockingConfiguration, decorator: Google::Apis::DfareportingV2_8::AdBlockingConfiguration::Representation - - collection :additional_creative_optimization_configurations, as: 'additionalCreativeOptimizationConfigurations', class: Google::Apis::DfareportingV2_8::CreativeOptimizationConfiguration, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :archived, as: 'archived' - collection :audience_segment_groups, as: 'audienceSegmentGroups', class: Google::Apis::DfareportingV2_8::AudienceSegmentGroup, decorator: Google::Apis::DfareportingV2_8::AudienceSegmentGroup::Representation - - property :billing_invoice_code, as: 'billingInvoiceCode' - property :click_through_url_suffix_properties, as: 'clickThroughUrlSuffixProperties', class: Google::Apis::DfareportingV2_8::ClickThroughUrlSuffixProperties, decorator: Google::Apis::DfareportingV2_8::ClickThroughUrlSuffixProperties::Representation - - property :comment, as: 'comment' - property :create_info, as: 'createInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation - - collection :creative_group_ids, as: 'creativeGroupIds' - property :creative_optimization_configuration, as: 'creativeOptimizationConfiguration', class: Google::Apis::DfareportingV2_8::CreativeOptimizationConfiguration, decorator: Google::Apis::DfareportingV2_8::CreativeOptimizationConfiguration::Representation - - property :default_click_through_event_tag_properties, as: 'defaultClickThroughEventTagProperties', class: Google::Apis::DfareportingV2_8::DefaultClickThroughEventTagProperties, decorator: Google::Apis::DfareportingV2_8::DefaultClickThroughEventTagProperties::Representation - - property :end_date, as: 'endDate', type: Date - - collection :event_tag_overrides, as: 'eventTagOverrides', class: Google::Apis::DfareportingV2_8::EventTagOverride, decorator: Google::Apis::DfareportingV2_8::EventTagOverride::Representation - - property :external_id, as: 'externalId' - property :id, :numeric_string => true, as: 'id' - property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :kind, as: 'kind' - property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation - - property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV2_8::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CampaignCreativeAssociation, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Campaign, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ChangeLog, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::City, decorator: Google::Apis::DfareportingV2_8::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 :event_name, as: 'eventName' - property :name, as: 'name' - property :value, as: 'value' - 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::DfareportingV2_8::ClickThroughUrl, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CrossDimensionReachReportCompatibleFields, decorator: Google::Apis::DfareportingV2_8::CrossDimensionReachReportCompatibleFields::Representation - - property :floodlight_report_compatible_fields, as: 'floodlightReportCompatibleFields', class: Google::Apis::DfareportingV2_8::FloodlightReportCompatibleFields, decorator: Google::Apis::DfareportingV2_8::FloodlightReportCompatibleFields::Representation - - property :kind, as: 'kind' - property :path_to_conversion_report_compatible_fields, as: 'pathToConversionReportCompatibleFields', class: Google::Apis::DfareportingV2_8::PathToConversionReportCompatibleFields, decorator: Google::Apis::DfareportingV2_8::PathToConversionReportCompatibleFields::Representation - - property :reach_report_compatible_fields, as: 'reachReportCompatibleFields', class: Google::Apis::DfareportingV2_8::ReachReportCompatibleFields, decorator: Google::Apis::DfareportingV2_8::ReachReportCompatibleFields::Representation - - property :report_compatible_fields, as: 'reportCompatibleFields', class: Google::Apis::DfareportingV2_8::ReportCompatibleFields, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ConnectionType, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ContentCategory, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CustomFloodlightVariable, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Conversion, decorator: Google::Apis::DfareportingV2_8::Conversion::Representation - - collection :errors, as: 'errors', class: Google::Apis::DfareportingV2_8::ConversionError, decorator: Google::Apis::DfareportingV2_8::ConversionError::Representation - - property :kind, as: 'kind' - end - end - - class ConversionsBatchInsertRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :conversions, as: 'conversions', class: Google::Apis::DfareportingV2_8::Conversion, decorator: Google::Apis::DfareportingV2_8::Conversion::Representation - - property :encryption_info, as: 'encryptionInfo', class: Google::Apis::DfareportingV2_8::EncryptionInfo, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ConversionStatus, decorator: Google::Apis::DfareportingV2_8::ConversionStatus::Representation - - end - end - - class ConversionsBatchUpdateRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :conversions, as: 'conversions', class: Google::Apis::DfareportingV2_8::Conversion, decorator: Google::Apis::DfareportingV2_8::Conversion::Representation - - property :encryption_info, as: 'encryptionInfo', class: Google::Apis::DfareportingV2_8::EncryptionInfo, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ConversionStatus, decorator: Google::Apis::DfareportingV2_8::ConversionStatus::Representation - - end - end - - class CountriesListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :countries, as: 'countries', class: Google::Apis::DfareportingV2_8::Country, decorator: Google::Apis::DfareportingV2_8::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' - collection :backup_image_features, as: 'backupImageFeatures' - property :backup_image_reporting_label, as: 'backupImageReportingLabel' - property :backup_image_target_window, as: 'backupImageTargetWindow', class: Google::Apis::DfareportingV2_8::TargetWindow, decorator: Google::Apis::DfareportingV2_8::TargetWindow::Representation - - collection :click_tags, as: 'clickTags', class: Google::Apis::DfareportingV2_8::ClickTag, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeCustomEvent, decorator: Google::Apis::DfareportingV2_8::CreativeCustomEvent::Representation - - property :creative_asset_selection, as: 'creativeAssetSelection', class: Google::Apis::DfareportingV2_8::CreativeAssetSelection, decorator: Google::Apis::DfareportingV2_8::CreativeAssetSelection::Representation - - collection :creative_assets, as: 'creativeAssets', class: Google::Apis::DfareportingV2_8::CreativeAsset, decorator: Google::Apis::DfareportingV2_8::CreativeAsset::Representation - - collection :creative_field_assignments, as: 'creativeFieldAssignments', class: Google::Apis::DfareportingV2_8::CreativeFieldAssignment, decorator: Google::Apis::DfareportingV2_8::CreativeFieldAssignment::Representation - - collection :custom_key_values, as: 'customKeyValues' - property :dynamic_asset_selection, as: 'dynamicAssetSelection' - collection :exit_custom_events, as: 'exitCustomEvents', class: Google::Apis::DfareportingV2_8::CreativeCustomEvent, decorator: Google::Apis::DfareportingV2_8::CreativeCustomEvent::Representation - - property :fs_command, as: 'fsCommand', class: Google::Apis::DfareportingV2_8::FsCommand, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :kind, as: 'kind' - property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation - - property :latest_trafficked_creative_id, :numeric_string => true, as: 'latestTraffickedCreativeId' - property :name, as: 'name' - property :override_css, as: 'overrideCss' - property :progress_offset, as: 'progressOffset', class: Google::Apis::DfareportingV2_8::VideoOffset, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :required_flash_plugin_version, as: 'requiredFlashPluginVersion' - property :required_flash_version, as: 'requiredFlashVersion' - property :size, as: 'size', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::Size::Representation - - property :skip_offset, as: 'skipOffset', class: Google::Apis::DfareportingV2_8::VideoOffset, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ThirdPartyTrackingUrl, decorator: Google::Apis::DfareportingV2_8::ThirdPartyTrackingUrl::Representation - - collection :timer_custom_events, as: 'timerCustomEvents', class: Google::Apis::DfareportingV2_8::CreativeCustomEvent, decorator: Google::Apis::DfareportingV2_8::CreativeCustomEvent::Representation - - property :total_file_size, :numeric_string => true, as: 'totalFileSize' - property :type, as: 'type' - property :universal_ad_id, as: 'universalAdId', class: Google::Apis::DfareportingV2_8::UniversalAdId, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeAssetId, decorator: Google::Apis::DfareportingV2_8::CreativeAssetId::Representation - - property :backup_image_exit, as: 'backupImageExit', class: Google::Apis::DfareportingV2_8::CreativeCustomEvent, decorator: Google::Apis::DfareportingV2_8::CreativeCustomEvent::Representation - - property :bit_rate, as: 'bitRate' - property :child_asset_type, as: 'childAssetType' - property :collapsed_size, as: 'collapsedSize', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :mime_type, as: 'mimeType' - property :offset, as: 'offset', class: Google::Apis::DfareportingV2_8::OffsetPosition, decorator: Google::Apis::DfareportingV2_8::OffsetPosition::Representation - - property :original_backup, as: 'originalBackup' - property :position, as: 'position', class: Google::Apis::DfareportingV2_8::OffsetPosition, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeAssetId, decorator: Google::Apis::DfareportingV2_8::CreativeAssetId::Representation - - collection :click_tags, as: 'clickTags', class: Google::Apis::DfareportingV2_8::ClickTag, decorator: Google::Apis::DfareportingV2_8::ClickTag::Representation - - collection :detected_features, as: 'detectedFeatures' - property :id, :numeric_string => true, as: 'id' - property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Rule, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ClickThroughUrl, decorator: Google::Apis::DfareportingV2_8::ClickThroughUrl::Representation - - collection :companion_creative_overrides, as: 'companionCreativeOverrides', class: Google::Apis::DfareportingV2_8::CompanionClickThroughOverride, decorator: Google::Apis::DfareportingV2_8::CompanionClickThroughOverride::Representation - - collection :creative_group_assignments, as: 'creativeGroupAssignments', class: Google::Apis::DfareportingV2_8::CreativeGroupAssignment, decorator: Google::Apis::DfareportingV2_8::CreativeGroupAssignment::Representation - - property :creative_id, :numeric_string => true, as: 'creativeId' - property :creative_id_dimension_value, as: 'creativeIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :end_time, as: 'endTime', type: DateTime - - collection :rich_media_exit_overrides, as: 'richMediaExitOverrides', class: Google::Apis::DfareportingV2_8::RichMediaExitOverride, decorator: Google::Apis::DfareportingV2_8::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 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_url, as: 'exitUrl' - property :id, :numeric_string => true, as: 'id' - property :popup_window_properties, as: 'popupWindowProperties', class: Google::Apis::DfareportingV2_8::PopupWindowProperties, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeFieldValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeField, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeGroup, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::OptimizationActivity, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeAssignment, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Creative, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation - - collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation - - property :kind, as: 'kind' - collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation - - collection :overlap_metrics, as: 'overlapMetrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FrequencyCap, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionFilter, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DirectorySiteContactAssignment, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DirectorySiteSettings, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DirectorySiteContact, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DfpSettings, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DirectorySite, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DynamicTargetingKey, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :campaign_id, :numeric_string => true, as: 'campaignId' - property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::EventTag, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DateRange, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::File::Urls, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::File, decorator: Google::Apis::DfareportingV2_8::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 :kind, as: 'kind' - end - end - - class FloodlightActivitiesListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :floodlight_activities, as: 'floodlightActivities', class: Google::Apis::DfareportingV2_8::FloodlightActivity, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :cache_busting_type, as: 'cacheBustingType' - property :counting_method, as: 'countingMethod' - collection :default_tags, as: 'defaultTags', class: Google::Apis::DfareportingV2_8::FloodlightActivityDynamicTag, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :hidden, as: 'hidden' - property :id, :numeric_string => true, as: 'id' - property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :image_tag_enabled, as: 'imageTagEnabled' - property :kind, as: 'kind' - property :name, as: 'name' - property :notes, as: 'notes' - collection :publisher_tags, as: 'publisherTags', class: Google::Apis::DfareportingV2_8::FloodlightActivityPublisherDynamicTag, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :floodlight_configuration_id, :numeric_string => true, as: 'floodlightConfigurationId' - property :floodlight_configuration_id_dimension_value, as: 'floodlightConfigurationIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :id, :numeric_string => true, as: 'id' - property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivityGroup, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivityDynamicTag, decorator: Google::Apis::DfareportingV2_8::FloodlightActivityDynamicTag::Representation - - property :site_id, :numeric_string => true, as: 'siteId' - property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :in_app_attribution_tracking_enabled, as: 'inAppAttributionTrackingEnabled' - property :kind, as: 'kind' - property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV2_8::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_8::LookbackConfiguration::Representation - - property :natural_search_conversion_attribution_option, as: 'naturalSearchConversionAttributionOption' - property :omniture_settings, as: 'omnitureSettings', class: Google::Apis::DfareportingV2_8::OmnitureSettings, decorator: Google::Apis::DfareportingV2_8::OmnitureSettings::Representation - - property :subaccount_id, :numeric_string => true, as: 'subaccountId' - property :tag_settings, as: 'tagSettings', class: Google::Apis::DfareportingV2_8::TagSettings, decorator: Google::Apis::DfareportingV2_8::TagSettings::Representation - - collection :third_party_authentication_tokens, as: 'thirdPartyAuthenticationTokens', class: Google::Apis::DfareportingV2_8::ThirdPartyAuthenticationToken, decorator: Google::Apis::DfareportingV2_8::ThirdPartyAuthenticationToken::Representation - - collection :user_defined_variable_configurations, as: 'userDefinedVariableConfigurations', class: Google::Apis::DfareportingV2_8::UserDefinedVariableConfiguration, decorator: Google::Apis::DfareportingV2_8::UserDefinedVariableConfiguration::Representation - - end - end - - class FloodlightConfigurationsListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :floodlight_configurations, as: 'floodlightConfigurations', class: Google::Apis::DfareportingV2_8::FloodlightConfiguration, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation - - collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation - - property :kind, as: 'kind' - collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::City, decorator: Google::Apis::DfareportingV2_8::City::Representation - - collection :countries, as: 'countries', class: Google::Apis::DfareportingV2_8::Country, decorator: Google::Apis::DfareportingV2_8::Country::Representation - - property :exclude_countries, as: 'excludeCountries' - collection :metros, as: 'metros', class: Google::Apis::DfareportingV2_8::Metro, decorator: Google::Apis::DfareportingV2_8::Metro::Representation - - collection :postal_codes, as: 'postalCodes', class: Google::Apis::DfareportingV2_8::PostalCode, decorator: Google::Apis::DfareportingV2_8::PostalCode::Representation - - collection :regions, as: 'regions', class: Google::Apis::DfareportingV2_8::Region, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AdSlot, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Pricing, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::InventoryItem, decorator: Google::Apis::DfareportingV2_8::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 :default, as: 'default' - property :id, :numeric_string => true, as: 'id' - property :kind, as: 'kind' - property :name, as: 'name' - property :url, as: 'url' - end - end - - class LandingPagesListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - collection :landing_pages, as: 'landingPages', class: Google::Apis::DfareportingV2_8::LandingPage, decorator: Google::Apis::DfareportingV2_8::LandingPage::Representation - - 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::DfareportingV2_8::Language, decorator: Google::Apis::DfareportingV2_8::Language::Representation - - end - end - - class LanguagesListResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - collection :languages, as: 'languages', class: Google::Apis::DfareportingV2_8::Language, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ListPopulationTerm, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ListPopulationClause, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Metro, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::MobileCarrier, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::OperatingSystem, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::OperatingSystemVersion, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::OperatingSystem, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::OrderContact, decorator: Google::Apis::DfareportingV2_8::OrderContact::Representation - - property :id, :numeric_string => true, as: 'id' - property :kind, as: 'kind' - property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::OrderDocument, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Order, decorator: Google::Apis::DfareportingV2_8::Order::Representation - - end - end - - class PathToConversionReportCompatibleFields - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :conversion_dimensions, as: 'conversionDimensions', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation - - collection :custom_floodlight_variables, as: 'customFloodlightVariables', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation - - property :kind, as: 'kind' - collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation - - collection :per_interaction_dimensions, as: 'perInteractionDimensions', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :archived, as: 'archived' - property :campaign_id, :numeric_string => true, as: 'campaignId' - property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation - - property :directory_site_id, :numeric_string => true, as: 'directorySiteId' - property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :external_id, as: 'externalId' - property :id, :numeric_string => true, as: 'id' - property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :key_name, as: 'keyName' - property :kind, as: 'kind' - property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation - - property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV2_8::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :placement_strategy_id, :numeric_string => true, as: 'placementStrategyId' - property :pricing_schedule, as: 'pricingSchedule', class: Google::Apis::DfareportingV2_8::PricingSchedule, decorator: Google::Apis::DfareportingV2_8::PricingSchedule::Representation - - property :primary, as: 'primary' - property :publisher_update_info, as: 'publisherUpdateInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation - - property :site_id, :numeric_string => true, as: 'siteId' - property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :size, as: 'size', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TagSetting, decorator: Google::Apis::DfareportingV2_8::TagSetting::Representation - - property :video_active_view_opt_out, as: 'videoActiveViewOptOut' - property :video_settings, as: 'videoSettings', class: Google::Apis::DfareportingV2_8::VideoSettings, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :archived, as: 'archived' - property :campaign_id, :numeric_string => true, as: 'campaignId' - property :campaign_id_dimension_value, as: 'campaignIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::LastModifiedInfo::Representation - - property :directory_site_id, :numeric_string => true, as: 'directorySiteId' - property :directory_site_id_dimension_value, as: 'directorySiteIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :external_id, as: 'externalId' - property :id, :numeric_string => true, as: 'id' - property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :kind, as: 'kind' - property :last_modified_info, as: 'lastModifiedInfo', class: Google::Apis::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PricingSchedule, decorator: Google::Apis::DfareportingV2_8::PricingSchedule::Representation - - property :primary_placement_id, :numeric_string => true, as: 'primaryPlacementId' - property :primary_placement_id_dimension_value, as: 'primaryPlacementIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :site_id, :numeric_string => true, as: 'siteId' - property :site_id_dimension_value, as: 'siteIdDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementGroup, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementStrategy, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TagData, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementTag, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Placement, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlatformType, decorator: Google::Apis::DfareportingV2_8::PlatformType::Representation - - end - end - - class PopupWindowProperties - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :dimension, as: 'dimension', class: Google::Apis::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::Size::Representation - - property :offset, as: 'offset', class: Google::Apis::DfareportingV2_8::OffsetPosition, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PostalCode, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Flight, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PricingSchedulePricingPeriod, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::LastModifiedInfo, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Project, decorator: Google::Apis::DfareportingV2_8::Project::Representation - - end - end - - class ReachReportCompatibleFields - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation - - collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation - - property :kind, as: 'kind' - collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation - - collection :pivoted_activity_metrics, as: 'pivotedActivityMetrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation - - collection :reach_by_frequency_metrics, as: 'reachByFrequencyMetrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Region, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ListPopulationRule, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RemarketingList, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Report::Criteria, decorator: Google::Apis::DfareportingV2_8::Report::Criteria::Representation - - property :cross_dimension_reach_criteria, as: 'crossDimensionReachCriteria', class: Google::Apis::DfareportingV2_8::Report::CrossDimensionReachCriteria, decorator: Google::Apis::DfareportingV2_8::Report::CrossDimensionReachCriteria::Representation - - property :delivery, as: 'delivery', class: Google::Apis::DfareportingV2_8::Report::Delivery, decorator: Google::Apis::DfareportingV2_8::Report::Delivery::Representation - - property :etag, as: 'etag' - property :file_name, as: 'fileName' - property :floodlight_criteria, as: 'floodlightCriteria', class: Google::Apis::DfareportingV2_8::Report::FloodlightCriteria, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Report::PathToConversionCriteria, decorator: Google::Apis::DfareportingV2_8::Report::PathToConversionCriteria::Representation - - property :reach_criteria, as: 'reachCriteria', class: Google::Apis::DfareportingV2_8::Report::ReachCriteria, decorator: Google::Apis::DfareportingV2_8::Report::ReachCriteria::Representation - - property :schedule, as: 'schedule', class: Google::Apis::DfareportingV2_8::Report::Schedule, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Activities, decorator: Google::Apis::DfareportingV2_8::Activities::Representation - - property :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV2_8::CustomRichMediaEvents, decorator: Google::Apis::DfareportingV2_8::CustomRichMediaEvents::Representation - - property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_8::DateRange, decorator: Google::Apis::DfareportingV2_8::DateRange::Representation - - collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_8::SortedDimension, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::SortedDimension, decorator: Google::Apis::DfareportingV2_8::SortedDimension::Representation - - property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_8::DateRange, decorator: Google::Apis::DfareportingV2_8::DateRange::Representation - - property :dimension, as: 'dimension' - collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Recipient, decorator: Google::Apis::DfareportingV2_8::Recipient::Representation - - end - end - - class FloodlightCriteria - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_8::DateRange, decorator: Google::Apis::DfareportingV2_8::DateRange::Representation - - collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_8::SortedDimension, decorator: Google::Apis::DfareportingV2_8::SortedDimension::Representation - - property :floodlight_config_id, as: 'floodlightConfigId', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - collection :metric_names, as: 'metricNames' - property :report_properties, as: 'reportProperties', class: Google::Apis::DfareportingV2_8::Report::FloodlightCriteria::ReportProperties, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - collection :conversion_dimensions, as: 'conversionDimensions', class: Google::Apis::DfareportingV2_8::SortedDimension, decorator: Google::Apis::DfareportingV2_8::SortedDimension::Representation - - collection :custom_floodlight_variables, as: 'customFloodlightVariables', class: Google::Apis::DfareportingV2_8::SortedDimension, decorator: Google::Apis::DfareportingV2_8::SortedDimension::Representation - - collection :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_8::DateRange, decorator: Google::Apis::DfareportingV2_8::DateRange::Representation - - property :floodlight_config_id, as: 'floodlightConfigId', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - collection :metric_names, as: 'metricNames' - collection :per_interaction_dimensions, as: 'perInteractionDimensions', class: Google::Apis::DfareportingV2_8::SortedDimension, decorator: Google::Apis::DfareportingV2_8::SortedDimension::Representation - - property :report_properties, as: 'reportProperties', class: Google::Apis::DfareportingV2_8::Report::PathToConversionCriteria::ReportProperties, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Activities, decorator: Google::Apis::DfareportingV2_8::Activities::Representation - - property :custom_rich_media_events, as: 'customRichMediaEvents', class: Google::Apis::DfareportingV2_8::CustomRichMediaEvents, decorator: Google::Apis::DfareportingV2_8::CustomRichMediaEvents::Representation - - property :date_range, as: 'dateRange', class: Google::Apis::DfareportingV2_8::DateRange, decorator: Google::Apis::DfareportingV2_8::DateRange::Representation - - collection :dimension_filters, as: 'dimensionFilters', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_8::SortedDimension, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation - - collection :dimensions, as: 'dimensions', class: Google::Apis::DfareportingV2_8::Dimension, decorator: Google::Apis::DfareportingV2_8::Dimension::Representation - - property :kind, as: 'kind' - collection :metrics, as: 'metrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation - - collection :pivoted_activity_metrics, as: 'pivotedActivityMetrics', class: Google::Apis::DfareportingV2_8::Metric, decorator: Google::Apis::DfareportingV2_8::Metric::Representation - - end - end - - class ReportList - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :etag, as: 'etag' - collection :items, as: 'items', class: Google::Apis::DfareportingV2_8::Report, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ClickThroughUrl, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :id, :numeric_string => true, as: 'id' - property :id_dimension_value, as: 'idDimensionValue', class: Google::Apis::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :key_name, as: 'keyName' - property :kind, as: 'kind' - property :name, as: 'name' - collection :site_contacts, as: 'siteContacts', class: Google::Apis::DfareportingV2_8::SiteContact, decorator: Google::Apis::DfareportingV2_8::SiteContact::Representation - - property :site_settings, as: 'siteSettings', class: Google::Apis::DfareportingV2_8::SiteSettings, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeSettings, decorator: Google::Apis::DfareportingV2_8::CreativeSettings::Representation - - property :disable_new_cookie, as: 'disableNewCookie' - property :lookback_configuration, as: 'lookbackConfiguration', class: Google::Apis::DfareportingV2_8::LookbackConfiguration, decorator: Google::Apis::DfareportingV2_8::LookbackConfiguration::Representation - - property :tag_setting, as: 'tagSetting', class: Google::Apis::DfareportingV2_8::TagSetting, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Site, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::VideoOffset, decorator: Google::Apis::DfareportingV2_8::VideoOffset::Representation - - property :skip_offset, as: 'skipOffset', class: Google::Apis::DfareportingV2_8::VideoOffset, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Subaccount, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TargetableRemarketingList, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValue, decorator: Google::Apis::DfareportingV2_8::DimensionValue::Representation - - property :day_part_targeting, as: 'dayPartTargeting', class: Google::Apis::DfareportingV2_8::DayPartTargeting, decorator: Google::Apis::DfareportingV2_8::DayPartTargeting::Representation - - property :geo_targeting, as: 'geoTargeting', class: Google::Apis::DfareportingV2_8::GeoTargeting, decorator: Google::Apis::DfareportingV2_8::GeoTargeting::Representation - - property :id, :numeric_string => true, as: 'id' - property :key_value_targeting_expression, as: 'keyValueTargetingExpression', class: Google::Apis::DfareportingV2_8::KeyValueTargetingExpression, decorator: Google::Apis::DfareportingV2_8::KeyValueTargetingExpression::Representation - - property :kind, as: 'kind' - property :language_targeting, as: 'languageTargeting', class: Google::Apis::DfareportingV2_8::LanguageTargeting, decorator: Google::Apis::DfareportingV2_8::LanguageTargeting::Representation - - property :list_targeting_expression, as: 'listTargetingExpression', class: Google::Apis::DfareportingV2_8::ListTargetingExpression, decorator: Google::Apis::DfareportingV2_8::ListTargetingExpression::Representation - - property :name, as: 'name' - property :subaccount_id, :numeric_string => true, as: 'subaccountId' - property :technology_targeting, as: 'technologyTargeting', class: Google::Apis::DfareportingV2_8::TechnologyTargeting, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TargetingTemplate, decorator: Google::Apis::DfareportingV2_8::TargetingTemplate::Representation - - end - end - - class TechnologyTargeting - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :browsers, as: 'browsers', class: Google::Apis::DfareportingV2_8::Browser, decorator: Google::Apis::DfareportingV2_8::Browser::Representation - - collection :connection_types, as: 'connectionTypes', class: Google::Apis::DfareportingV2_8::ConnectionType, decorator: Google::Apis::DfareportingV2_8::ConnectionType::Representation - - collection :mobile_carriers, as: 'mobileCarriers', class: Google::Apis::DfareportingV2_8::MobileCarrier, decorator: Google::Apis::DfareportingV2_8::MobileCarrier::Representation - - collection :operating_system_versions, as: 'operatingSystemVersions', class: Google::Apis::DfareportingV2_8::OperatingSystemVersion, decorator: Google::Apis::DfareportingV2_8::OperatingSystemVersion::Representation - - collection :operating_systems, as: 'operatingSystems', class: Google::Apis::DfareportingV2_8::OperatingSystem, decorator: Google::Apis::DfareportingV2_8::OperatingSystem::Representation - - collection :platform_types, as: 'platformTypes', class: Google::Apis::DfareportingV2_8::PlatformType, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserProfile, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRolePermission, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRolePermissionGroup, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRolePermission, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRole, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Size, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::VideoFormat, decorator: Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CompanionSetting, decorator: Google::Apis::DfareportingV2_8::CompanionSetting::Representation - - property :kind, as: 'kind' - property :skippable_settings, as: 'skippableSettings', class: Google::Apis::DfareportingV2_8::SkippableSetting, decorator: Google::Apis::DfareportingV2_8::SkippableSetting::Representation - - property :transcode_settings, as: 'transcodeSettings', class: Google::Apis::DfareportingV2_8::TranscodeSetting, decorator: Google::Apis::DfareportingV2_8::TranscodeSetting::Representation - - end - end - end - end -end diff --git a/generated/google/apis/dfareporting_v2_8/service.rb b/generated/google/apis/dfareporting_v2_8/service.rb deleted file mode 100644 index 53749ec64..000000000 --- a/generated/google/apis/dfareporting_v2_8/service.rb +++ /dev/null @@ -1,8727 +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 DfareportingV2_8 - # DCM/DFA Reporting And Trafficking API - # - # Manages your DoubleClick Campaign Manager ad campaigns and reports. - # - # @example - # require 'google/apis/dfareporting_v2_8' - # - # Dfareporting = Google::Apis::DfareportingV2_8 # 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] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - attr_accessor :quota_user - - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - - def initialize - super('https://www.googleapis.com/', 'dfareporting/v2.8/') - @batch_path = 'batch/dfareporting/v2.8' - 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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AccountActiveAdSummary] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountActiveAdSummary::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AccountPermissionGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountPermissionGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AccountPermissionGroupsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountPermissionGroupsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AccountPermission] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountPermission::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AccountPermissionsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountPermissionsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AccountUserProfile] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountUserProfile::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountUserProfile] account_user_profile_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AccountUserProfile] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountUserProfile::Representation - command.request_object = account_user_profile_object - command.response_representation = Google::Apis::DfareportingV2_8::AccountUserProfile::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AccountUserProfilesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountUserProfilesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountUserProfile] account_user_profile_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AccountUserProfile] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountUserProfile::Representation - command.request_object = account_user_profile_object - command.response_representation = Google::Apis::DfareportingV2_8::AccountUserProfile::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountUserProfile] account_user_profile_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AccountUserProfile] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountUserProfile::Representation - command.request_object = account_user_profile_object - command.response_representation = Google::Apis::DfareportingV2_8::AccountUserProfile::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Account] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Account::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AccountsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AccountsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Account] account_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Account] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Account::Representation - command.request_object = account_object - command.response_representation = Google::Apis::DfareportingV2_8::Account::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Account] account_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Account] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Account::Representation - command.request_object = account_object - command.response_representation = Google::Apis::DfareportingV2_8::Account::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Ad] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Ad::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Ad] ad_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Ad] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Ad::Representation - command.request_object = ad_object - command.response_representation = Google::Apis::DfareportingV2_8::Ad::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AdsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AdsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Ad] ad_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Ad] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Ad::Representation - command.request_object = ad_object - command.response_representation = Google::Apis::DfareportingV2_8::Ad::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Ad] ad_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Ad] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Ad::Representation - command.request_object = ad_object - command.response_representation = Google::Apis::DfareportingV2_8::Ad::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AdvertiserGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AdvertiserGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AdvertiserGroup] advertiser_group_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AdvertiserGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AdvertiserGroup::Representation - command.request_object = advertiser_group_object - command.response_representation = Google::Apis::DfareportingV2_8::AdvertiserGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AdvertiserGroupsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AdvertiserGroupsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AdvertiserGroup] advertiser_group_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AdvertiserGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AdvertiserGroup::Representation - command.request_object = advertiser_group_object - command.response_representation = Google::Apis::DfareportingV2_8::AdvertiserGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AdvertiserGroup] advertiser_group_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AdvertiserGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AdvertiserGroup::Representation - command.request_object = advertiser_group_object - command.response_representation = Google::Apis::DfareportingV2_8::AdvertiserGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Advertiser] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Advertiser::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Advertiser] advertiser_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Advertiser] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Advertiser::Representation - command.request_object = advertiser_object - command.response_representation = Google::Apis::DfareportingV2_8::Advertiser::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::AdvertisersListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::AdvertisersListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Advertiser] advertiser_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Advertiser] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Advertiser::Representation - command.request_object = advertiser_object - command.response_representation = Google::Apis::DfareportingV2_8::Advertiser::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Advertiser] advertiser_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Advertiser] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Advertiser::Representation - command.request_object = advertiser_object - command.response_representation = Google::Apis::DfareportingV2_8::Advertiser::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::BrowsersListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::BrowsersListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CampaignCreativeAssociation] campaign_creative_association_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CampaignCreativeAssociation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CampaignCreativeAssociation::Representation - command.request_object = campaign_creative_association_object - command.response_representation = Google::Apis::DfareportingV2_8::CampaignCreativeAssociation::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CampaignCreativeAssociationsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CampaignCreativeAssociationsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Campaign] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Campaign::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 [String] default_landing_page_name - # Default landing page name for this new campaign. Must be less than 256 - # characters long. - # @param [String] default_landing_page_url - # Default landing page URL for this new campaign. - # @param [Google::Apis::DfareportingV2_8::Campaign] campaign_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Campaign] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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, default_landing_page_name, default_landing_page_url, 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::DfareportingV2_8::Campaign::Representation - command.request_object = campaign_object - command.response_representation = Google::Apis::DfareportingV2_8::Campaign::Representation - command.response_class = Google::Apis::DfareportingV2_8::Campaign - command.params['profileId'] = profile_id unless profile_id.nil? - command.query['defaultLandingPageName'] = default_landing_page_name unless default_landing_page_name.nil? - command.query['defaultLandingPageUrl'] = default_landing_page_url unless default_landing_page_url.nil? - command.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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CampaignsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CampaignsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Campaign] campaign_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Campaign] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Campaign::Representation - command.request_object = campaign_object - command.response_representation = Google::Apis::DfareportingV2_8::Campaign::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Campaign] campaign_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Campaign] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Campaign::Representation - command.request_object = campaign_object - command.response_representation = Google::Apis::DfareportingV2_8::Campaign::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::ChangeLog] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ChangeLog::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::ChangeLogsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ChangeLogsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CitiesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CitiesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::ConnectionType] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ConnectionType::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::ConnectionTypesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ConnectionTypesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::ContentCategory] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ContentCategory::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ContentCategory] content_category_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::ContentCategory] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ContentCategory::Representation - command.request_object = content_category_object - command.response_representation = Google::Apis::DfareportingV2_8::ContentCategory::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::ContentCategoriesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ContentCategoriesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ContentCategory] content_category_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::ContentCategory] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ContentCategory::Representation - command.request_object = content_category_object - command.response_representation = Google::Apis::DfareportingV2_8::ContentCategory::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ContentCategory] content_category_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::ContentCategory] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ContentCategory::Representation - command.request_object = content_category_object - command.response_representation = Google::Apis::DfareportingV2_8::ContentCategory::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ConversionsBatchInsertRequest] conversions_batch_insert_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::ConversionsBatchInsertResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ConversionsBatchInsertRequest::Representation - command.request_object = conversions_batch_insert_request_object - command.response_representation = Google::Apis::DfareportingV2_8::ConversionsBatchInsertResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ConversionsBatchUpdateRequest] conversions_batch_update_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::ConversionsBatchUpdateResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ConversionsBatchUpdateRequest::Representation - command.request_object = conversions_batch_update_request_object - command.response_representation = Google::Apis::DfareportingV2_8::ConversionsBatchUpdateResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Country] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Country::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CountriesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CountriesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeAssetMetadata] creative_asset_metadata_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @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::DfareportingV2_8::CreativeAssetMetadata] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeAssetMetadata::Representation - command.request_object = creative_asset_metadata_object - command.response_representation = Google::Apis::DfareportingV2_8::CreativeAssetMetadata::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeFieldValue] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeFieldValue::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeFieldValue] creative_field_value_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeFieldValue] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeFieldValue::Representation - command.request_object = creative_field_value_object - command.response_representation = Google::Apis::DfareportingV2_8::CreativeFieldValue::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeFieldValuesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeFieldValuesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeFieldValue] creative_field_value_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeFieldValue] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeFieldValue::Representation - command.request_object = creative_field_value_object - command.response_representation = Google::Apis::DfareportingV2_8::CreativeFieldValue::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeFieldValue] creative_field_value_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeFieldValue] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeFieldValue::Representation - command.request_object = creative_field_value_object - command.response_representation = Google::Apis::DfareportingV2_8::CreativeFieldValue::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeField] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeField::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeField] creative_field_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeField] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeField::Representation - command.request_object = creative_field_object - command.response_representation = Google::Apis::DfareportingV2_8::CreativeField::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeFieldsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeFieldsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeField] creative_field_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeField] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeField::Representation - command.request_object = creative_field_object - command.response_representation = Google::Apis::DfareportingV2_8::CreativeField::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeField] creative_field_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeField] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeField::Representation - command.request_object = creative_field_object - command.response_representation = Google::Apis::DfareportingV2_8::CreativeField::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeGroup] creative_group_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeGroup::Representation - command.request_object = creative_group_object - command.response_representation = Google::Apis::DfareportingV2_8::CreativeGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeGroupsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeGroupsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeGroup] creative_group_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeGroup::Representation - command.request_object = creative_group_object - command.response_representation = Google::Apis::DfareportingV2_8::CreativeGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeGroup] creative_group_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativeGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativeGroup::Representation - command.request_object = creative_group_object - command.response_representation = Google::Apis::DfareportingV2_8::CreativeGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Creative] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Creative::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Creative] creative_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Creative] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Creative::Representation - command.request_object = creative_object - command.response_representation = Google::Apis::DfareportingV2_8::Creative::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CreativesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::CreativesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Creative] creative_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Creative] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Creative::Representation - command.request_object = creative_object - command.response_representation = Google::Apis::DfareportingV2_8::Creative::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Creative] creative_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Creative] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Creative::Representation - command.request_object = creative_object - command.response_representation = Google::Apis::DfareportingV2_8::Creative::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::DimensionValueList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DimensionValueRequest::Representation - command.request_object = dimension_value_request_object - command.response_representation = Google::Apis::DfareportingV2_8::DimensionValueList::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::DirectorySiteContact] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DirectorySiteContact::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::DirectorySiteContactsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DirectorySiteContactsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::DirectorySite] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DirectorySite::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DirectorySite] directory_site_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::DirectorySite] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DirectorySite::Representation - command.request_object = directory_site_object - command.response_representation = Google::Apis::DfareportingV2_8::DirectorySite::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 Ad Manager 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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::DirectorySitesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DirectorySitesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @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::DfareportingV2_8::DynamicTargetingKey] dynamic_targeting_key_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::DynamicTargetingKey] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DynamicTargetingKey::Representation - command.request_object = dynamic_targeting_key_object - command.response_representation = Google::Apis::DfareportingV2_8::DynamicTargetingKey::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::DynamicTargetingKeysListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::DynamicTargetingKeysListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::EventTag] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::EventTag::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::EventTag] event_tag_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::EventTag] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::EventTag::Representation - command.request_object = event_tag_object - command.response_representation = Google::Apis::DfareportingV2_8::EventTag::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::EventTagsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::EventTagsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::EventTag] event_tag_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::EventTag] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::EventTag::Representation - command.request_object = event_tag_object - command.response_representation = Google::Apis::DfareportingV2_8::EventTag::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::EventTag] event_tag_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::EventTag] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::EventTag::Representation - command.request_object = event_tag_object - command.response_representation = Google::Apis::DfareportingV2_8::EventTag::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @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::DfareportingV2_8::File] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::File::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FileList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FileList::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivitiesGenerateTagResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivitiesGenerateTagResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivity] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivity::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivity] floodlight_activity_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivity] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivity::Representation - command.request_object = floodlight_activity_object - command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivity::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivitiesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivitiesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivity] floodlight_activity_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivity] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivity::Representation - command.request_object = floodlight_activity_object - command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivity::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivity] floodlight_activity_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivity] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivity::Representation - command.request_object = floodlight_activity_object - command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivity::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivityGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivityGroup] floodlight_activity_group_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivityGroup::Representation - command.request_object = floodlight_activity_group_object - command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivityGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivityGroupsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivityGroupsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivityGroup] floodlight_activity_group_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivityGroup::Representation - command.request_object = floodlight_activity_group_object - command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivityGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivityGroup] floodlight_activity_group_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightActivityGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightActivityGroup::Representation - command.request_object = floodlight_activity_group_object - command.response_representation = Google::Apis::DfareportingV2_8::FloodlightActivityGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightConfiguration] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightConfiguration::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightConfigurationsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightConfigurationsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightConfiguration] floodlight_configuration_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightConfiguration] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightConfiguration::Representation - command.request_object = floodlight_configuration_object - command.response_representation = Google::Apis::DfareportingV2_8::FloodlightConfiguration::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightConfiguration] floodlight_configuration_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FloodlightConfiguration] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FloodlightConfiguration::Representation - command.request_object = floodlight_configuration_object - command.response_representation = Google::Apis::DfareportingV2_8::FloodlightConfiguration::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::InventoryItem] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::InventoryItem::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::InventoryItemsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::InventoryItemsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - - # Deletes an existing campaign landing page. - # @param [Fixnum] profile_id - # User profile ID associated with this request. - # @param [Fixnum] campaign_id - # Landing page campaign ID. - # @param [Fixnum] id - # Landing page ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @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_landing_page(profile_id, campaign_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}', options) - command.params['profileId'] = profile_id unless profile_id.nil? - command.params['campaignId'] = campaign_id unless campaign_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 campaign landing page by ID. - # @param [Fixnum] profile_id - # User profile ID associated with this request. - # @param [Fixnum] campaign_id - # Landing page campaign ID. - # @param [Fixnum] id - # Landing page ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::LandingPage] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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_landing_page(profile_id, campaign_id, id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages/{id}', options) - command.response_representation = Google::Apis::DfareportingV2_8::LandingPage::Representation - command.response_class = Google::Apis::DfareportingV2_8::LandingPage - command.params['profileId'] = profile_id unless profile_id.nil? - command.params['campaignId'] = campaign_id unless campaign_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 for the specified campaign. - # @param [Fixnum] profile_id - # User profile ID associated with this request. - # @param [Fixnum] campaign_id - # Landing page campaign ID. - # @param [Google::Apis::DfareportingV2_8::LandingPage] landing_page_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::LandingPage] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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_landing_page(profile_id, campaign_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages', options) - command.request_representation = Google::Apis::DfareportingV2_8::LandingPage::Representation - command.request_object = landing_page_object - command.response_representation = Google::Apis::DfareportingV2_8::LandingPage::Representation - command.response_class = Google::Apis::DfareportingV2_8::LandingPage - 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 landing pages for the specified campaign. - # @param [Fixnum] profile_id - # User profile ID associated with this request. - # @param [Fixnum] campaign_id - # Landing page campaign ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::LandingPagesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::LandingPagesListResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_landing_pages(profile_id, campaign_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages', options) - command.response_representation = Google::Apis::DfareportingV2_8::LandingPagesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::LandingPagesListResponse - 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 - - # Updates an existing campaign landing page. This method supports patch - # semantics. - # @param [Fixnum] profile_id - # User profile ID associated with this request. - # @param [Fixnum] campaign_id - # Landing page campaign ID. - # @param [Fixnum] id - # Landing page ID. - # @param [Google::Apis::DfareportingV2_8::LandingPage] landing_page_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::LandingPage] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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_landing_page(profile_id, campaign_id, id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages', options) - command.request_representation = Google::Apis::DfareportingV2_8::LandingPage::Representation - command.request_object = landing_page_object - command.response_representation = Google::Apis::DfareportingV2_8::LandingPage::Representation - command.response_class = Google::Apis::DfareportingV2_8::LandingPage - command.params['profileId'] = profile_id unless profile_id.nil? - command.params['campaignId'] = campaign_id unless campaign_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 landing page. - # @param [Fixnum] profile_id - # User profile ID associated with this request. - # @param [Fixnum] campaign_id - # Landing page campaign ID. - # @param [Google::Apis::DfareportingV2_8::LandingPage] landing_page_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::LandingPage] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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_landing_page(profile_id, campaign_id, landing_page_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'userprofiles/{profileId}/campaigns/{campaignId}/landingPages', options) - command.request_representation = Google::Apis::DfareportingV2_8::LandingPage::Representation - command.request_object = landing_page_object - command.response_representation = Google::Apis::DfareportingV2_8::LandingPage::Representation - command.response_class = Google::Apis::DfareportingV2_8::LandingPage - 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 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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::LanguagesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::LanguagesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::MetrosListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::MetrosListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::MobileCarrier] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::MobileCarrier::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::MobileCarriersListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::MobileCarriersListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::OperatingSystemVersion] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::OperatingSystemVersion::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::OperatingSystemVersionsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::OperatingSystemVersionsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::OperatingSystem] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::OperatingSystem::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::OperatingSystemsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::OperatingSystemsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::OrderDocument] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::OrderDocument::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::OrderDocumentsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::OrderDocumentsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Order] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Order::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::OrdersListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::OrdersListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementGroup] placement_group_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementGroup::Representation - command.request_object = placement_group_object - command.response_representation = Google::Apis::DfareportingV2_8::PlacementGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementGroupsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementGroupsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementGroup] placement_group_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementGroup::Representation - command.request_object = placement_group_object - command.response_representation = Google::Apis::DfareportingV2_8::PlacementGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementGroup] placement_group_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementGroup::Representation - command.request_object = placement_group_object - command.response_representation = Google::Apis::DfareportingV2_8::PlacementGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementStrategy] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementStrategy::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementStrategy] placement_strategy_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementStrategy] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementStrategy::Representation - command.request_object = placement_strategy_object - command.response_representation = Google::Apis::DfareportingV2_8::PlacementStrategy::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementStrategiesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementStrategiesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementStrategy] placement_strategy_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementStrategy] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementStrategy::Representation - command.request_object = placement_strategy_object - command.response_representation = Google::Apis::DfareportingV2_8::PlacementStrategy::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementStrategy] placement_strategy_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementStrategy] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementStrategy::Representation - command.request_object = placement_strategy_object - command.response_representation = Google::Apis::DfareportingV2_8::PlacementStrategy::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementsGenerateTagsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementsGenerateTagsResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Placement] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Placement::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Placement] placement_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Placement] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Placement::Representation - command.request_object = placement_object - command.response_representation = Google::Apis::DfareportingV2_8::Placement::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PlacementsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlacementsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Placement] placement_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Placement] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Placement::Representation - command.request_object = placement_object - command.response_representation = Google::Apis::DfareportingV2_8::Placement::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Placement] placement_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Placement] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Placement::Representation - command.request_object = placement_object - command.response_representation = Google::Apis::DfareportingV2_8::Placement::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PlatformType] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlatformType::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PlatformTypesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PlatformTypesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PostalCode] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PostalCode::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::PostalCodesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::PostalCodesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Project] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Project::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::ProjectsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ProjectsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::RegionsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RegionsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingListShare] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RemarketingListShare::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RemarketingListShare] remarketing_list_share_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingListShare] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RemarketingListShare::Representation - command.request_object = remarketing_list_share_object - command.response_representation = Google::Apis::DfareportingV2_8::RemarketingListShare::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RemarketingListShare] remarketing_list_share_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingListShare] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RemarketingListShare::Representation - command.request_object = remarketing_list_share_object - command.response_representation = Google::Apis::DfareportingV2_8::RemarketingListShare::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RemarketingList::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RemarketingList] remarketing_list_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RemarketingList::Representation - command.request_object = remarketing_list_object - command.response_representation = Google::Apis::DfareportingV2_8::RemarketingList::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingListsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RemarketingListsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RemarketingList] remarketing_list_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RemarketingList::Representation - command.request_object = remarketing_list_object - command.response_representation = Google::Apis::DfareportingV2_8::RemarketingList::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RemarketingList] remarketing_list_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::RemarketingList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::RemarketingList::Representation - command.request_object = remarketing_list_object - command.response_representation = Google::Apis::DfareportingV2_8::RemarketingList::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Report] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Report::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Report] report_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Report] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Report::Representation - command.request_object = report_object - command.response_representation = Google::Apis::DfareportingV2_8::Report::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::ReportList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::ReportList::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Report] report_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Report] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Report::Representation - command.request_object = report_object - command.response_representation = Google::Apis::DfareportingV2_8::Report::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::File] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::File::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Report] report_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Report] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Report::Representation - command.request_object = report_object - command.response_representation = Google::Apis::DfareportingV2_8::Report::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Report] report_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::CompatibleFields] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Report::Representation - command.request_object = report_object - command.response_representation = Google::Apis::DfareportingV2_8::CompatibleFields::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @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::DfareportingV2_8::File] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::File::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::FileList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::FileList::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Site] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Site::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Site] site_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Site] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Site::Representation - command.request_object = site_object - command.response_representation = Google::Apis::DfareportingV2_8::Site::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::SitesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::SitesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Site] site_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Site] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Site::Representation - command.request_object = site_object - command.response_representation = Google::Apis::DfareportingV2_8::Site::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Site] site_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Site] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Site::Representation - command.request_object = site_object - command.response_representation = Google::Apis::DfareportingV2_8::Site::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Size] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Size::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Size] size_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Size] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Size::Representation - command.request_object = size_object - command.response_representation = Google::Apis::DfareportingV2_8::Size::Representation - command.response_class = Google::Apis::DfareportingV2_8::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. Retrieved sizes are globally - # unique and may include values not currently in use by your account. Due to - # this, the list of sizes returned by this method may differ from the list seen - # in the Trafficking UI. - # @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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::SizesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::SizesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Subaccount] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Subaccount::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Subaccount] subaccount_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Subaccount] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Subaccount::Representation - command.request_object = subaccount_object - command.response_representation = Google::Apis::DfareportingV2_8::Subaccount::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::SubaccountsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::SubaccountsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Subaccount] subaccount_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Subaccount] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Subaccount::Representation - command.request_object = subaccount_object - command.response_representation = Google::Apis::DfareportingV2_8::Subaccount::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Subaccount] subaccount_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::Subaccount] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::Subaccount::Representation - command.request_object = subaccount_object - command.response_representation = Google::Apis::DfareportingV2_8::Subaccount::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::TargetableRemarketingList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TargetableRemarketingList::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::TargetableRemarketingListsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TargetableRemarketingListsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::TargetingTemplate] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TargetingTemplate::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TargetingTemplate] targeting_template_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::TargetingTemplate] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TargetingTemplate::Representation - command.request_object = targeting_template_object - command.response_representation = Google::Apis::DfareportingV2_8::TargetingTemplate::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::TargetingTemplatesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TargetingTemplatesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TargetingTemplate] targeting_template_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::TargetingTemplate] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TargetingTemplate::Representation - command.request_object = targeting_template_object - command.response_representation = Google::Apis::DfareportingV2_8::TargetingTemplate::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TargetingTemplate] targeting_template_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::TargetingTemplate] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::TargetingTemplate::Representation - command.request_object = targeting_template_object - command.response_representation = Google::Apis::DfareportingV2_8::TargetingTemplate::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::UserProfile] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserProfile::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::UserProfileList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserProfileList::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::UserRolePermissionGroup] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRolePermissionGroup::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::UserRolePermissionGroupsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRolePermissionGroupsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::UserRolePermission] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRolePermission::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::UserRolePermissionsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRolePermissionsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::UserRole] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRole::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRole] user_role_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::UserRole] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRole::Representation - command.request_object = user_role_object - command.response_representation = Google::Apis::DfareportingV2_8::UserRole::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::UserRolesListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRolesListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRole] user_role_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::UserRole] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRole::Representation - command.request_object = user_role_object - command.response_representation = Google::Apis::DfareportingV2_8::UserRole::Representation - command.response_class = Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRole] user_role_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::UserRole] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::UserRole::Representation - command.request_object = user_role_object - command.response_representation = Google::Apis::DfareportingV2_8::UserRole::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::VideoFormat] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::VideoFormat::Representation - command.response_class = Google::Apis::DfareportingV2_8::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 - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::DfareportingV2_8::VideoFormatsListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::DfareportingV2_8::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::DfareportingV2_8::VideoFormatsListResponse::Representation - command.response_class = Google::Apis::DfareportingV2_8::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/dialogflow_v2.rb b/generated/google/apis/dialogflow_v2.rb index 88410343a..098afc268 100644 --- a/generated/google/apis/dialogflow_v2.rb +++ b/generated/google/apis/dialogflow_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow-enterprise/ module DialogflowV2 VERSION = 'V2' - REVISION = '20181015' + REVISION = '20181022' # 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/dialogflow_v2beta1.rb b/generated/google/apis/dialogflow_v2beta1.rb index 5343e58e7..2842c134a 100644 --- a/generated/google/apis/dialogflow_v2beta1.rb +++ b/generated/google/apis/dialogflow_v2beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow-enterprise/ module DialogflowV2beta1 VERSION = 'V2beta1' - REVISION = '20181017' + REVISION = '20181022' # 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/digitalassetlinks_v1.rb b/generated/google/apis/digitalassetlinks_v1.rb index 855d1889a..ab2da38bd 100644 --- a/generated/google/apis/digitalassetlinks_v1.rb +++ b/generated/google/apis/digitalassetlinks_v1.rb @@ -20,13 +20,12 @@ module Google module Apis # Digital Asset Links API # - # API for discovering relationships between online assets such as web sites or - # mobile apps. + # Discovers relationships between online assets such as websites or mobile apps. # # @see https://developers.google.com/digital-asset-links/ module DigitalassetlinksV1 VERSION = 'V1' - REVISION = '20180606' + REVISION = '20181103' end end end diff --git a/generated/google/apis/digitalassetlinks_v1/service.rb b/generated/google/apis/digitalassetlinks_v1/service.rb index eb0d810e8..d18fada53 100644 --- a/generated/google/apis/digitalassetlinks_v1/service.rb +++ b/generated/google/apis/digitalassetlinks_v1/service.rb @@ -22,8 +22,7 @@ module Google module DigitalassetlinksV1 # Digital Asset Links API # - # API for discovering relationships between online assets such as web sites or - # mobile apps. + # Discovers relationships between online assets such as websites or mobile apps. # # @example # require 'google/apis/digitalassetlinks_v1' diff --git a/generated/google/apis/dlp_v2.rb b/generated/google/apis/dlp_v2.rb index f1ed404f5..97f0639a1 100644 --- a/generated/google/apis/dlp_v2.rb +++ b/generated/google/apis/dlp_v2.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/dlp/docs/ module DlpV2 VERSION = 'V2' - REVISION = '20181002' + REVISION = '20181030' # 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_v2/classes.rb b/generated/google/apis/dlp_v2/classes.rb index 9a2cdf892..d07dde42d 100644 --- a/generated/google/apis/dlp_v2/classes.rb +++ b/generated/google/apis/dlp_v2/classes.rb @@ -238,6 +238,12 @@ module Google class GooglePrivacyDlpV2BigQueryOptions include Google::Apis::Core::Hashable + # References to fields excluded from scanning. This allows you to skip + # inspection of entire columns which you know have no findings. + # Corresponds to the JSON property `excludedFields` + # @return [Array] + attr_accessor :excluded_fields + # References to fields uniquely identifying rows within the table. # Nested fields in the format, like `person.birthdate.year`, are allowed. # Corresponds to the JSON property `identifyingFields` @@ -281,6 +287,7 @@ module Google # Update properties of this object def update!(**args) + @excluded_fields = args[:excluded_fields] if args.key?(:excluded_fields) @identifying_fields = args[:identifying_fields] if args.key?(:identifying_fields) @rows_limit = args[:rows_limit] if args.key?(:rows_limit) @rows_limit_percent = args[:rows_limit_percent] if args.key?(:rows_limit_percent) @@ -683,7 +690,8 @@ module Google # List of file type groups to include in the scan. # If empty, all files are scanned and available data format processors - # are applied. + # are applied. In addition, the binary content of the selected files + # is always scanned as well. # Corresponds to the JSON property `fileTypes` # @return [Array] attr_accessor :file_types @@ -1482,6 +1490,7 @@ module Google end # Message for a date time object. + # e.g. 2018-01-01, 5th August. class GooglePrivacyDlpV2DateTime include Google::Apis::Core::Hashable @@ -2547,7 +2556,8 @@ module Google # Name of the information type. Either a name of your choosing when # creating a CustomInfoType, or one of the names listed # at https://cloud.google.com/dlp/docs/infotypes-reference when specifying - # a built-in type. + # a built-in type. InfoType names should conform to the pattern + # [a-zA-Z0-9_]`1,64`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3062,7 +3072,7 @@ module Google attr_accessor :display_name # A stream of errors encountered when the trigger was activated. Repeated - # errors may result in the JobTrigger automaticaly being paused. + # errors may result in the JobTrigger automatically being paused. # Will return the last 100 errors. Whenever the JobTrigger is modified # this list will be cleared. Output only field. # Corresponds to the JSON property `errors` @@ -3929,8 +3939,9 @@ module Google # from the `Finding` object. If appending to an existing table, any columns # from the predefined schema that are missing will be added. No columns in # the existing table will be deleted. - # If unspecified, then all available columns will be used for a new table, - # and no changes will be made to an existing table. + # If unspecified, then all available columns will be used for a new table or + # an (existing) table with no schema, and no changes will be made to an + # existing table that has a schema. # Corresponds to the JSON property `outputSchema` # @return [String] attr_accessor :output_schema @@ -4374,6 +4385,7 @@ module Google include Google::Apis::Core::Hashable # Message for a date time object. + # e.g. 2018-01-01, 5th August. # Corresponds to the JSON property `dateTime` # @return [Google::Apis::DlpV2::GooglePrivacyDlpV2DateTime] attr_accessor :date_time diff --git a/generated/google/apis/dlp_v2/representations.rb b/generated/google/apis/dlp_v2/representations.rb index 192b0d542..9bc392069 100644 --- a/generated/google/apis/dlp_v2/representations.rb +++ b/generated/google/apis/dlp_v2/representations.rb @@ -1104,6 +1104,8 @@ module Google class GooglePrivacyDlpV2BigQueryOptions # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :excluded_fields, as: 'excludedFields', class: Google::Apis::DlpV2::GooglePrivacyDlpV2FieldId, decorator: Google::Apis::DlpV2::GooglePrivacyDlpV2FieldId::Representation + collection :identifying_fields, as: 'identifyingFields', class: Google::Apis::DlpV2::GooglePrivacyDlpV2FieldId, decorator: Google::Apis::DlpV2::GooglePrivacyDlpV2FieldId::Representation property :rows_limit, :numeric_string => true, as: 'rowsLimit' diff --git a/generated/google/apis/doubleclicksearch_v2.rb b/generated/google/apis/doubleclicksearch_v2.rb index f020467a8..1e777b752 100644 --- a/generated/google/apis/doubleclicksearch_v2.rb +++ b/generated/google/apis/doubleclicksearch_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/doubleclick-search/ module DoubleclicksearchV2 VERSION = 'V2' - REVISION = '20180802' + REVISION = '20181030' # View and manage your advertising data in DoubleClick Search AUTH_DOUBLECLICKSEARCH = 'https://www.googleapis.com/auth/doubleclicksearch' diff --git a/generated/google/apis/doubleclicksearch_v2/classes.rb b/generated/google/apis/doubleclicksearch_v2/classes.rb index 9f760a667..0bff4ade0 100644 --- a/generated/google/apis/doubleclicksearch_v2/classes.rb +++ b/generated/google/apis/doubleclicksearch_v2/classes.rb @@ -652,7 +652,7 @@ module Google # @return [String] attr_accessor :report_type - # Synchronous report only. The maxinum number of rows to return; additional rows + # Synchronous report only. The maximum number of rows to return; additional rows # are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000. # Corresponds to the JSON property `rowCount` # @return [Fixnum] diff --git a/generated/google/apis/drive_v2.rb b/generated/google/apis/drive_v2.rb index 254522783..6f45f5eca 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 = '20180830' + REVISION = '20181022' # 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 b835e1ace..6c19bfe70 100644 --- a/generated/google/apis/drive_v2/classes.rb +++ b/generated/google/apis/drive_v2/classes.rb @@ -1339,7 +1339,9 @@ module Google # @return [String] attr_accessor :description - # + # Short lived download URL for the file. This field is only populated for files + # with content stored in Drive; it is not populated for Google Docs or shortcut + # files. # Corresponds to the JSON property `downloadUrl` # @return [String] attr_accessor :download_url diff --git a/generated/google/apis/firestore_v1.rb b/generated/google/apis/firestore_v1.rb index ea098e5be..975066a2a 100644 --- a/generated/google/apis/firestore_v1.rb +++ b/generated/google/apis/firestore_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/firestore module FirestoreV1 VERSION = 'V1' - REVISION = '20180814' + REVISION = '20181020' # 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_v1/classes.rb b/generated/google/apis/firestore_v1/classes.rb index b1a3c89d4..531de144c 100644 --- a/generated/google/apis/firestore_v1/classes.rb +++ b/generated/google/apis/firestore_v1/classes.rb @@ -41,6 +41,643 @@ module Google end end + # Metadata for google.longrunning.Operation results from + # FirestoreAdmin.ExportDocuments. + class GoogleFirestoreAdminV1ExportDocumentsMetadata + include Google::Apis::Core::Hashable + + # Which collection ids are being exported. + # Corresponds to the JSON property `collectionIds` + # @return [Array] + attr_accessor :collection_ids + + # The time this operation completed. Will be unset if operation still in + # progress. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # The state of the export operation. + # Corresponds to the JSON property `operationState` + # @return [String] + attr_accessor :operation_state + + # Where the entities are being exported to. + # Corresponds to the JSON property `outputUriPrefix` + # @return [String] + attr_accessor :output_uri_prefix + + # Describes the progress of the operation. + # Unit of work is generic and must be interpreted based on where Progress + # is used. + # Corresponds to the JSON property `progressBytes` + # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] + attr_accessor :progress_bytes + + # Describes the progress of the operation. + # Unit of work is generic and must be interpreted based on where Progress + # is used. + # Corresponds to the JSON property `progressDocuments` + # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] + attr_accessor :progress_documents + + # The time this operation started. + # 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) + @collection_ids = args[:collection_ids] if args.key?(:collection_ids) + @end_time = args[:end_time] if args.key?(:end_time) + @operation_state = args[:operation_state] if args.key?(:operation_state) + @output_uri_prefix = args[:output_uri_prefix] if args.key?(:output_uri_prefix) + @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes) + @progress_documents = args[:progress_documents] if args.key?(:progress_documents) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + + # The request for FirestoreAdmin.ExportDocuments. + class GoogleFirestoreAdminV1ExportDocumentsRequest + include Google::Apis::Core::Hashable + + # Which collection ids to export. Unspecified means all collections. + # Corresponds to the JSON property `collectionIds` + # @return [Array] + attr_accessor :collection_ids + + # The output URI. Currently only supports Google Cloud Storage URIs of the + # form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name + # of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional + # Google Cloud Storage namespace path. When + # choosing a name, be sure to consider Google Cloud Storage naming + # guidelines: https://cloud.google.com/storage/docs/naming. + # If the URI is a bucket (without a namespace path), a prefix will be + # generated based on the start time. + # Corresponds to the JSON property `outputUriPrefix` + # @return [String] + attr_accessor :output_uri_prefix + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @collection_ids = args[:collection_ids] if args.key?(:collection_ids) + @output_uri_prefix = args[:output_uri_prefix] if args.key?(:output_uri_prefix) + end + end + + # Returned in the google.longrunning.Operation response field. + class GoogleFirestoreAdminV1ExportDocumentsResponse + include Google::Apis::Core::Hashable + + # Location of the output files. This can be used to begin an import + # into Cloud Firestore (this project or another project) after the operation + # completes successfully. + # Corresponds to the JSON property `outputUriPrefix` + # @return [String] + attr_accessor :output_uri_prefix + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @output_uri_prefix = args[:output_uri_prefix] if args.key?(:output_uri_prefix) + end + end + + # Represents a single field in the database. + # Fields are grouped by their "Collection Group", which represent all + # collections in the database with the same id. + class GoogleFirestoreAdminV1Field + include Google::Apis::Core::Hashable + + # The index configuration for this field. + # Corresponds to the JSON property `indexConfig` + # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfig] + attr_accessor :index_config + + # A field name of the form + # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` + # /fields/`field_path`` + # A field path may be a simple field name, e.g. `address` or a path to fields + # within map_value , e.g. `address.city`, + # or a special field path. The only valid special field is `*`, which + # represents any field. + # Field paths may be quoted using ` (backtick). The only character that needs + # to be escaped within a quoted field path is the backtick character itself, + # escaped using a backslash. Special characters in field paths that + # must be quoted include: `*`, `.`, + # ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. + # Examples: + # (Note: Comments here are written in markdown syntax, so there is an + # additional layer of backticks to represent a code block) + # `\`address.city\`` represents a field named `address.city`, not the map key + # `city` in the field `address`. + # `\`*\`` represents a field named `*`, not any field. + # A special `Field` contains the default indexing settings for all fields. + # This field's resource name is: + # `projects/`project_id`/databases/`database_id`/collectionGroups/__default__/ + # fields/*` + # Indexes defined on this `Field` will be applied to all fields which do not + # have their own `Field` index configuration. + # 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) + @index_config = args[:index_config] if args.key?(:index_config) + @name = args[:name] if args.key?(:name) + end + end + + # Metadata for google.longrunning.Operation results from + # FirestoreAdmin.UpdateField. + class GoogleFirestoreAdminV1FieldOperationMetadata + include Google::Apis::Core::Hashable + + # The time this operation completed. Will be unset if operation still in + # progress. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # The field resource that this operation is acting on. For example: + # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` + # /fields/`field_path`` + # Corresponds to the JSON property `field` + # @return [String] + attr_accessor :field + + # A list of IndexConfigDelta, which describe the intent of this + # operation. + # Corresponds to the JSON property `indexConfigDeltas` + # @return [Array] + attr_accessor :index_config_deltas + + # Describes the progress of the operation. + # Unit of work is generic and must be interpreted based on where Progress + # is used. + # Corresponds to the JSON property `progressBytes` + # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] + attr_accessor :progress_bytes + + # Describes the progress of the operation. + # Unit of work is generic and must be interpreted based on where Progress + # is used. + # Corresponds to the JSON property `progressDocuments` + # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] + attr_accessor :progress_documents + + # The time this operation started. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # The state of the operation. + # 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) + @end_time = args[:end_time] if args.key?(:end_time) + @field = args[:field] if args.key?(:field) + @index_config_deltas = args[:index_config_deltas] if args.key?(:index_config_deltas) + @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes) + @progress_documents = args[:progress_documents] if args.key?(:progress_documents) + @start_time = args[:start_time] if args.key?(:start_time) + @state = args[:state] if args.key?(:state) + end + end + + # Metadata for google.longrunning.Operation results from + # FirestoreAdmin.ImportDocuments. + class GoogleFirestoreAdminV1ImportDocumentsMetadata + include Google::Apis::Core::Hashable + + # Which collection ids are being imported. + # Corresponds to the JSON property `collectionIds` + # @return [Array] + attr_accessor :collection_ids + + # The time this operation completed. Will be unset if operation still in + # progress. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # The location of the documents being imported. + # Corresponds to the JSON property `inputUriPrefix` + # @return [String] + attr_accessor :input_uri_prefix + + # The state of the import operation. + # Corresponds to the JSON property `operationState` + # @return [String] + attr_accessor :operation_state + + # Describes the progress of the operation. + # Unit of work is generic and must be interpreted based on where Progress + # is used. + # Corresponds to the JSON property `progressBytes` + # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] + attr_accessor :progress_bytes + + # Describes the progress of the operation. + # Unit of work is generic and must be interpreted based on where Progress + # is used. + # Corresponds to the JSON property `progressDocuments` + # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] + attr_accessor :progress_documents + + # The time this operation started. + # 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) + @collection_ids = args[:collection_ids] if args.key?(:collection_ids) + @end_time = args[:end_time] if args.key?(:end_time) + @input_uri_prefix = args[:input_uri_prefix] if args.key?(:input_uri_prefix) + @operation_state = args[:operation_state] if args.key?(:operation_state) + @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes) + @progress_documents = args[:progress_documents] if args.key?(:progress_documents) + @start_time = args[:start_time] if args.key?(:start_time) + end + end + + # The request for FirestoreAdmin.ImportDocuments. + class GoogleFirestoreAdminV1ImportDocumentsRequest + include Google::Apis::Core::Hashable + + # Which collection ids to import. Unspecified means all collections included + # in the import. + # Corresponds to the JSON property `collectionIds` + # @return [Array] + attr_accessor :collection_ids + + # Location of the exported files. + # This must match the output_uri_prefix of an ExportDocumentsResponse from + # an export that has completed successfully. + # See: + # google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix. + # Corresponds to the JSON property `inputUriPrefix` + # @return [String] + attr_accessor :input_uri_prefix + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @collection_ids = args[:collection_ids] if args.key?(:collection_ids) + @input_uri_prefix = args[:input_uri_prefix] if args.key?(:input_uri_prefix) + end + end + + # Cloud Firestore indexes enable simple and complex queries against + # documents in a database. + class GoogleFirestoreAdminV1Index + include Google::Apis::Core::Hashable + + # The fields supported by this index. + # For composite indexes, this is always 2 or more fields. + # The last field entry is always for the field path `__name__`. If, on + # creation, `__name__` was not specified as the last field, it will be added + # automatically with the same direction as that of the last field defined. If + # the final field in a composite index is not directional, the `__name__` + # will be ordered ASCENDING (unless explicitly specified). + # For single field indexes, this will always be exactly one entry with a + # field path equal to the field path of the associated field. + # Corresponds to the JSON property `fields` + # @return [Array] + attr_accessor :fields + + # Output only. + # A server defined name for this index. + # The form of this name for composite indexes will be: + # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` + # /indexes/`composite_index_id`` + # For single field indexes, this field will be empty. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Indexes with a collection query scope specified allow queries + # against a collection that is the child of a specific document, specified at + # query time, and that has the same collection id. + # Indexes with a collection group query scope specified allow queries against + # all collections descended from a specific document, specified at query + # time, and that have the same collection id as this index. + # Corresponds to the JSON property `queryScope` + # @return [String] + attr_accessor :query_scope + + # Output only. + # The serving state of the index. + # 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) + @fields = args[:fields] if args.key?(:fields) + @name = args[:name] if args.key?(:name) + @query_scope = args[:query_scope] if args.key?(:query_scope) + @state = args[:state] if args.key?(:state) + end + end + + # The index configuration for this field. + class GoogleFirestoreAdminV1IndexConfig + include Google::Apis::Core::Hashable + + # Output only. + # Specifies the resource name of the `Field` from which this field's + # index configuration is set (when `uses_ancestor_config` is true), + # or from which it *would* be set if this field had no index configuration + # (when `uses_ancestor_config` is false). + # Corresponds to the JSON property `ancestorField` + # @return [String] + attr_accessor :ancestor_field + + # The indexes supported for this field. + # Corresponds to the JSON property `indexes` + # @return [Array] + attr_accessor :indexes + + # Output only + # When true, the `Field`'s index configuration is in the process of being + # reverted. Once complete, the index config will transition to the same + # state as the field specified by `ancestor_field`, at which point + # `uses_ancestor_config` will be `true` and `reverting` will be `false`. + # Corresponds to the JSON property `reverting` + # @return [Boolean] + attr_accessor :reverting + alias_method :reverting?, :reverting + + # Output only. + # When true, the `Field`'s index configuration is set from the + # configuration specified by the `ancestor_field`. + # When false, the `Field`'s index configuration is defined explicitly. + # Corresponds to the JSON property `usesAncestorConfig` + # @return [Boolean] + attr_accessor :uses_ancestor_config + alias_method :uses_ancestor_config?, :uses_ancestor_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ancestor_field = args[:ancestor_field] if args.key?(:ancestor_field) + @indexes = args[:indexes] if args.key?(:indexes) + @reverting = args[:reverting] if args.key?(:reverting) + @uses_ancestor_config = args[:uses_ancestor_config] if args.key?(:uses_ancestor_config) + end + end + + # Information about an index configuration change. + class GoogleFirestoreAdminV1IndexConfigDelta + include Google::Apis::Core::Hashable + + # Specifies how the index is changing. + # Corresponds to the JSON property `changeType` + # @return [String] + attr_accessor :change_type + + # Cloud Firestore indexes enable simple and complex queries against + # documents in a database. + # Corresponds to the JSON property `index` + # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index] + attr_accessor :index + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @change_type = args[:change_type] if args.key?(:change_type) + @index = args[:index] if args.key?(:index) + end + end + + # A field in an index. + # The field_path describes which field is indexed, the value_mode describes + # how the field value is indexed. + class GoogleFirestoreAdminV1IndexField + include Google::Apis::Core::Hashable + + # Indicates that this field supports operations on `array_value`s. + # Corresponds to the JSON property `arrayConfig` + # @return [String] + attr_accessor :array_config + + # Can be __name__. + # For single field indexes, this must match the name of the field or may + # be omitted. + # Corresponds to the JSON property `fieldPath` + # @return [String] + attr_accessor :field_path + + # Indicates that this field supports ordering by the specified order or + # comparing using =, <, <=, >, >=. + # Corresponds to the JSON property `order` + # @return [String] + attr_accessor :order + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @array_config = args[:array_config] if args.key?(:array_config) + @field_path = args[:field_path] if args.key?(:field_path) + @order = args[:order] if args.key?(:order) + end + end + + # Metadata for google.longrunning.Operation results from + # FirestoreAdmin.CreateIndex. + class GoogleFirestoreAdminV1IndexOperationMetadata + include Google::Apis::Core::Hashable + + # The time this operation completed. Will be unset if operation still in + # progress. + # 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`/collectionGroups/`collection_id` + # /indexes/`index_id`` + # Corresponds to the JSON property `index` + # @return [String] + attr_accessor :index + + # Describes the progress of the operation. + # Unit of work is generic and must be interpreted based on where Progress + # is used. + # Corresponds to the JSON property `progressBytes` + # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] + attr_accessor :progress_bytes + + # Describes the progress of the operation. + # Unit of work is generic and must be interpreted based on where Progress + # is used. + # Corresponds to the JSON property `progressDocuments` + # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] + attr_accessor :progress_documents + + # The time this operation started. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # The state of the operation. + # 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) + @end_time = args[:end_time] if args.key?(:end_time) + @index = args[:index] if args.key?(:index) + @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes) + @progress_documents = args[:progress_documents] if args.key?(:progress_documents) + @start_time = args[:start_time] if args.key?(:start_time) + @state = args[:state] if args.key?(:state) + end + end + + # The response for FirestoreAdmin.ListFields. + class GoogleFirestoreAdminV1ListFieldsResponse + include Google::Apis::Core::Hashable + + # The requested fields. + # Corresponds to the JSON property `fields` + # @return [Array] + attr_accessor :fields + + # A page token that may be used to request another page of results. If blank, + # this is the last page. + # 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) + @fields = args[:fields] if args.key?(:fields) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The response for FirestoreAdmin.ListIndexes. + class GoogleFirestoreAdminV1ListIndexesResponse + include Google::Apis::Core::Hashable + + # The requested indexes. + # Corresponds to the JSON property `indexes` + # @return [Array] + attr_accessor :indexes + + # A page token that may be used to request another page of results. If blank, + # this is the last page. + # 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) + @indexes = args[:indexes] if args.key?(:indexes) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # The metadata message for google.cloud.location.Location.metadata. + class GoogleFirestoreAdminV1LocationMetadata + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # Describes the progress of the operation. + # Unit of work is generic and must be interpreted based on where Progress + # is used. + class GoogleFirestoreAdminV1Progress + include Google::Apis::Core::Hashable + + # The amount of work completed. + # Corresponds to the JSON property `completedWork` + # @return [Fixnum] + attr_accessor :completed_work + + # The amount of work estimated. + # Corresponds to the JSON property `estimatedWork` + # @return [Fixnum] + attr_accessor :estimated_work + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @completed_work = args[:completed_work] if args.key?(:completed_work) + @estimated_work = args[:estimated_work] if args.key?(:estimated_work) + end + end + # The request message for Operations.CancelOperation. class GoogleLongrunningCancelOperationRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/firestore_v1/representations.rb b/generated/google/apis/firestore_v1/representations.rb index c4015f34e..40df2a031 100644 --- a/generated/google/apis/firestore_v1/representations.rb +++ b/generated/google/apis/firestore_v1/representations.rb @@ -28,6 +28,102 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleFirestoreAdminV1ExportDocumentsMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1ExportDocumentsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1ExportDocumentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1Field + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1FieldOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1ImportDocumentsMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1ImportDocumentsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1Index + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1IndexConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1IndexConfigDelta + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1IndexField + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1IndexOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1ListFieldsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1ListIndexesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1LocationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleFirestoreAdminV1Progress + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleLongrunningCancelOperationRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -70,6 +166,170 @@ module Google end end + class GoogleFirestoreAdminV1ExportDocumentsMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :collection_ids, as: 'collectionIds' + property :end_time, as: 'endTime' + property :operation_state, as: 'operationState' + property :output_uri_prefix, as: 'outputUriPrefix' + property :progress_bytes, as: 'progressBytes', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress::Representation + + property :progress_documents, as: 'progressDocuments', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress::Representation + + property :start_time, as: 'startTime' + end + end + + class GoogleFirestoreAdminV1ExportDocumentsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :collection_ids, as: 'collectionIds' + property :output_uri_prefix, as: 'outputUriPrefix' + end + end + + class GoogleFirestoreAdminV1ExportDocumentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :output_uri_prefix, as: 'outputUriPrefix' + end + end + + class GoogleFirestoreAdminV1Field + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :index_config, as: 'indexConfig', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfig, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfig::Representation + + property :name, as: 'name' + end + end + + class GoogleFirestoreAdminV1FieldOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + property :field, as: 'field' + collection :index_config_deltas, as: 'indexConfigDeltas', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfigDelta, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfigDelta::Representation + + property :progress_bytes, as: 'progressBytes', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress::Representation + + property :progress_documents, as: 'progressDocuments', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress::Representation + + property :start_time, as: 'startTime' + property :state, as: 'state' + end + end + + class GoogleFirestoreAdminV1ImportDocumentsMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :collection_ids, as: 'collectionIds' + property :end_time, as: 'endTime' + property :input_uri_prefix, as: 'inputUriPrefix' + property :operation_state, as: 'operationState' + property :progress_bytes, as: 'progressBytes', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress::Representation + + property :progress_documents, as: 'progressDocuments', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress::Representation + + property :start_time, as: 'startTime' + end + end + + class GoogleFirestoreAdminV1ImportDocumentsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :collection_ids, as: 'collectionIds' + property :input_uri_prefix, as: 'inputUriPrefix' + end + end + + class GoogleFirestoreAdminV1Index + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :fields, as: 'fields', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexField, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexField::Representation + + property :name, as: 'name' + property :query_scope, as: 'queryScope' + property :state, as: 'state' + end + end + + class GoogleFirestoreAdminV1IndexConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ancestor_field, as: 'ancestorField' + collection :indexes, as: 'indexes', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index::Representation + + property :reverting, as: 'reverting' + property :uses_ancestor_config, as: 'usesAncestorConfig' + end + end + + class GoogleFirestoreAdminV1IndexConfigDelta + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :change_type, as: 'changeType' + property :index, as: 'index', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index::Representation + + end + end + + class GoogleFirestoreAdminV1IndexField + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :array_config, as: 'arrayConfig' + property :field_path, as: 'fieldPath' + property :order, as: 'order' + end + end + + class GoogleFirestoreAdminV1IndexOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + property :index, as: 'index' + property :progress_bytes, as: 'progressBytes', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress::Representation + + property :progress_documents, as: 'progressDocuments', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress::Representation + + property :start_time, as: 'startTime' + property :state, as: 'state' + end + end + + class GoogleFirestoreAdminV1ListFieldsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :fields, as: 'fields', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class GoogleFirestoreAdminV1ListIndexesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :indexes, as: 'indexes', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class GoogleFirestoreAdminV1LocationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GoogleFirestoreAdminV1Progress + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :completed_work, :numeric_string => true, as: 'completedWork' + property :estimated_work, :numeric_string => true, as: 'estimatedWork' + end + end + class GoogleLongrunningCancelOperationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/firestore_v1/service.rb b/generated/google/apis/firestore_v1/service.rb index 690535016..dedc87629 100644 --- a/generated/google/apis/firestore_v1/service.rb +++ b/generated/google/apis/firestore_v1/service.rb @@ -48,6 +48,383 @@ module Google @batch_path = 'batch' end + # Exports a copy of all or a subset of documents from Google Cloud Firestore + # to another storage system, such as Google Cloud Storage. Recent updates to + # documents may not be reflected in the export. The export occurs in the + # background and its progress can be monitored and managed via the + # Operation resource that is created. The output of an export may only be + # used once the associated operation is done. If an export operation is + # cancelled before completion it may leave partial data behind in Google + # Cloud Storage. + # @param [String] name + # Database to export. Should be of the form: + # `projects/`project_id`/databases/`database_id``. + # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ExportDocumentsRequest] google_firestore_admin_v1_export_documents_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::FirestoreV1::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirestoreV1::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_database_documents(name, google_firestore_admin_v1_export_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:exportDocuments', options) + command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ExportDocumentsRequest::Representation + command.request_object = google_firestore_admin_v1_export_documents_request_object + command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation + 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 + + # Imports documents into Google Cloud Firestore. Existing documents with the + # same name are overwritten. The import occurs in the background and its + # progress can be monitored and managed via the Operation resource that is + # created. If an ImportDocuments operation is cancelled, it is possible + # that a subset of the data has already been imported to Cloud Firestore. + # @param [String] name + # Database to import into. Should be of the form: + # `projects/`project_id`/databases/`database_id``. + # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ImportDocumentsRequest] google_firestore_admin_v1_import_documents_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::FirestoreV1::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirestoreV1::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_project_database_documents(name, google_firestore_admin_v1_import_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:importDocuments', options) + command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ImportDocumentsRequest::Representation + command.request_object = google_firestore_admin_v1_import_documents_request_object + command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation + 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 metadata and configuration for a Field. + # @param [String] name + # A name of the form + # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` + # /fields/`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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_database_collection_group_field(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field::Representation + command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field + 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 field configuration and metadata for this database. + # Currently, FirestoreAdmin.ListFields only supports listing fields + # that have been explicitly overridden. To issue this query, call + # FirestoreAdmin.ListFields with the filter set to + # `indexConfig.usesAncestorConfig:false`. + # @param [String] parent + # A parent name of the form + # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` + # ` + # @param [String] filter + # The filter to apply to list results. Currently, + # FirestoreAdmin.ListFields only supports listing fields + # that have been explicitly overridden. To issue this query, call + # FirestoreAdmin.ListFields with the filter set to + # `indexConfig.usesAncestorConfig:false`. + # @param [Fixnum] page_size + # The number of results to return. + # @param [String] page_token + # A page token, returned from a previous call to + # FirestoreAdmin.ListFields, that may be used 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListFieldsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListFieldsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_collection_group_fields(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/fields', options) + command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListFieldsResponse::Representation + command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListFieldsResponse + 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 + + # Updates a field configuration. Currently, field updates apply only to + # single field index configuration. However, calls to + # FirestoreAdmin.UpdateField should provide a field mask to avoid + # changing any configuration that the caller isn't aware of. The field mask + # should be specified as: `` paths: "index_config" ``. + # This call returns a google.longrunning.Operation which may be used to + # track the status of the field update. The metadata for + # the operation will be the type FieldOperationMetadata. + # To configure the default field settings for the database, use + # the special `Field` with resource name: + # `projects/`project_id`/databases/`database_id`/collectionGroups/__default__/ + # fields/*`. + # @param [String] name + # A field name of the form + # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` + # /fields/`field_path`` + # A field path may be a simple field name, e.g. `address` or a path to fields + # within map_value , e.g. `address.city`, + # or a special field path. The only valid special field is `*`, which + # represents any field. + # Field paths may be quoted using ` (backtick). The only character that needs + # to be escaped within a quoted field path is the backtick character itself, + # escaped using a backslash. Special characters in field paths that + # must be quoted include: `*`, `.`, + # ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. + # Examples: + # (Note: Comments here are written in markdown syntax, so there is an + # additional layer of backticks to represent a code block) + # `\`address.city\`` represents a field named `address.city`, not the map key + # `city` in the field `address`. + # `\`*\`` represents a field named `*`, not any field. + # A special `Field` contains the default indexing settings for all fields. + # This field's resource name is: + # `projects/`project_id`/databases/`database_id`/collectionGroups/__default__/ + # fields/*` + # Indexes defined on this `Field` will be applied to all fields which do not + # have their own `Field` index configuration. + # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field] google_firestore_admin_v1_field_object + # @param [String] update_mask + # A mask, relative to the field. If specified, only configuration specified + # by this field_mask will be updated in the 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirestoreV1::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirestoreV1::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_database_collection_group_field(name, google_firestore_admin_v1_field_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::FirestoreV1::GoogleFirestoreAdminV1Field::Representation + command.request_object = google_firestore_admin_v1_field_object + command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation + 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 composite index. This returns a google.longrunning.Operation + # which may be used to track the status of the creation. The metadata for + # the operation will be the type IndexOperationMetadata. + # @param [String] parent + # A parent name of the form + # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` + # ` + # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index] google_firestore_admin_v1_index_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::FirestoreV1::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirestoreV1::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_database_collection_group_index(parent, google_firestore_admin_v1_index_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/indexes', options) + command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index::Representation + command.request_object = google_firestore_admin_v1_index_object + command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation + 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 a composite index. + # @param [String] name + # A name of the form + # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` + # /indexes/`index_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::FirestoreV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirestoreV1::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_database_collection_group_index(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::FirestoreV1::Empty::Representation + command.response_class = Google::Apis::FirestoreV1::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 composite index. + # @param [String] name + # A name of the form + # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` + # /indexes/`index_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::FirestoreV1::GoogleFirestoreAdminV1Index] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_database_collection_group_index(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index::Representation + command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index + 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 composite indexes. + # @param [String] parent + # A parent name of the form + # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` + # ` + # @param [String] filter + # The filter to apply to list results. + # @param [Fixnum] page_size + # The number of results to return. + # @param [String] page_token + # A page token, returned from a previous call to + # FirestoreAdmin.ListIndexes, that may be used 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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListIndexesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListIndexesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_collection_group_indexes(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/indexes', options) + command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListIndexesResponse::Representation + command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListIndexesResponse + 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 + # 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 diff --git a/generated/google/apis/iamcredentials_v1.rb b/generated/google/apis/iamcredentials_v1.rb index a4730991d..ccf173932 100644 --- a/generated/google/apis/iamcredentials_v1.rb +++ b/generated/google/apis/iamcredentials_v1.rb @@ -20,12 +20,12 @@ module Google module Apis # IAM Service Account Credentials API # - # IAM Service Account Credentials API + # Creates short-lived, limited-privilege credentials for IAM service accounts. # # @see https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials module IamcredentialsV1 VERSION = 'V1' - REVISION = '20180921' + REVISION = '20181013' # 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/iamcredentials_v1/service.rb b/generated/google/apis/iamcredentials_v1/service.rb index c8f48d4af..0615aacc8 100644 --- a/generated/google/apis/iamcredentials_v1/service.rb +++ b/generated/google/apis/iamcredentials_v1/service.rb @@ -22,7 +22,7 @@ module Google module IamcredentialsV1 # IAM Service Account Credentials API # - # IAM Service Account Credentials API + # Creates short-lived, limited-privilege credentials for IAM service accounts. # # @example # require 'google/apis/iamcredentials_v1' diff --git a/generated/google/apis/jobs_v2.rb b/generated/google/apis/jobs_v2.rb index bd1d4c974..4fd284f5e 100644 --- a/generated/google/apis/jobs_v2.rb +++ b/generated/google/apis/jobs_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/talent-solution/job-search/docs/ module JobsV2 VERSION = 'V2' - REVISION = '20180927' + REVISION = '20181011' # 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/jobs_v2/classes.rb b/generated/google/apis/jobs_v2/classes.rb index 02c607d08..b03ad8bf6 100644 --- a/generated/google/apis/jobs_v2/classes.rb +++ b/generated/google/apis/jobs_v2/classes.rb @@ -2060,8 +2060,8 @@ module Google # existence of a key. # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of # nesting (For example, "((A AND B AND C) OR NOT D) AND E"), and there can - # be a maximum of 50 comparisons/functions in the expression. The expression - # must be < 3000 characters in length. + # be a maximum of 100 comparisons/functions in the expression. The expression + # must be < 3000 bytes in length. # Sample Query: # (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 # Corresponds to the JSON property `customAttributeFilter` diff --git a/generated/google/apis/jobs_v3.rb b/generated/google/apis/jobs_v3.rb index e5c37f6bf..5002d6ef4 100644 --- a/generated/google/apis/jobs_v3.rb +++ b/generated/google/apis/jobs_v3.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/talent-solution/job-search/docs/ module JobsV3 VERSION = 'V3' - REVISION = '20181011' + REVISION = '20181029' # 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/jobs_v3/classes.rb b/generated/google/apis/jobs_v3/classes.rb index c7b4d12ee..1821fd056 100644 --- a/generated/google/apis/jobs_v3/classes.rb +++ b/generated/google/apis/jobs_v3/classes.rb @@ -1648,7 +1648,7 @@ module Google # @return [Google::Apis::JobsV3::PostalAddress] attr_accessor :postal_address - # Radius in meters of the job location. This value is derived from the + # Radius in miles of the job location. This value is derived from the # location bounding box in which a circle with the specified radius # centered from LatLng coves the area associated with the job location. # For example, currently, "Mountain View, CA, USA" has a radius of diff --git a/generated/google/apis/jobs_v3p1beta1.rb b/generated/google/apis/jobs_v3p1beta1.rb index 560607da6..72ce5b50f 100644 --- a/generated/google/apis/jobs_v3p1beta1.rb +++ b/generated/google/apis/jobs_v3p1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/talent-solution/job-search/docs/ module JobsV3p1beta1 VERSION = 'V3p1beta1' - REVISION = '20180927' + REVISION = '20181029' # 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/jobs_v3p1beta1/classes.rb b/generated/google/apis/jobs_v3p1beta1/classes.rb index c91d804e7..be90a4df2 100644 --- a/generated/google/apis/jobs_v3p1beta1/classes.rb +++ b/generated/google/apis/jobs_v3p1beta1/classes.rb @@ -1707,9 +1707,9 @@ module Google # perform a case insensitive match and `EMPTY([field_name])` to filter on the # existence of a key. # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of - # nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50 + # nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 # comparisons or functions are allowed in the expression. The expression - # must be < 3000 characters in length. + # must be < 3000 bytes in length. # Sample Query: # `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND # driving_years > 10` @@ -1954,7 +1954,7 @@ module Google # @return [Google::Apis::JobsV3p1beta1::PostalAddress] attr_accessor :postal_address - # Radius in meters of the job location. This value is derived from the + # Radius in miles of the job location. This value is derived from the # location bounding box in which a circle with the specified radius # centered from LatLng coves the area associated with the job location. # For example, currently, "Mountain View, CA, USA" has a radius of diff --git a/generated/google/apis/jobs_v3p1beta1/service.rb b/generated/google/apis/jobs_v3p1beta1/service.rb index c86ddc8e0..26ce81f1f 100644 --- a/generated/google/apis/jobs_v3p1beta1/service.rb +++ b/generated/google/apis/jobs_v3p1beta1/service.rb @@ -61,7 +61,8 @@ module Google # The format is "projects/`project_id`/companies/`company_id`", for example, # "projects/api-test-project/companies/foo". # @param [String] language_code - # Required. + # Deprecated. Use language_codes instead. + # Optional. # The language of the query. This is # the BCP-47 language code, such as "en-US" or "sr-Latn". # For more information, see @@ -75,6 +76,21 @@ module Google # language_code or companies having open jobs with same # language_code are returned. # The maximum number of allowed characters is 255. + # @param [Array, String] language_codes + # Optional. + # The list of languages of the query. This is + # the BCP-47 language code, such as "en-US" or "sr-Latn". + # For more information, see + # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). + # For CompletionType.JOB_TITLE type, only open jobs with same + # language_codes are returned. + # For CompletionType.COMPANY_NAME type, + # only companies having open jobs with same language_codes are + # returned. + # For CompletionType.COMBINED type, only open jobs with same + # language_codes or companies having open jobs with same + # language_codes are returned. + # The maximum number of allowed characters is 255. # @param [Fixnum] page_size # Required. # Completion result count. @@ -106,13 +122,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 complete_project(name, company_name: nil, language_code: nil, page_size: nil, query: nil, scope: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block) + def complete_project(name, company_name: nil, language_code: nil, language_codes: nil, page_size: nil, query: nil, scope: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3p1beta1/{+name}:complete', options) command.response_representation = Google::Apis::JobsV3p1beta1::CompleteQueryResponse::Representation command.response_class = Google::Apis::JobsV3p1beta1::CompleteQueryResponse command.params['name'] = name unless name.nil? command.query['companyName'] = company_name unless company_name.nil? command.query['languageCode'] = language_code unless language_code.nil? + command.query['languageCodes'] = language_codes unless language_codes.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['query'] = query unless query.nil? command.query['scope'] = scope unless scope.nil? @@ -199,6 +216,7 @@ module Google end # Deletes specified company. + # Prerequisite: The company has no jobs associated with it. # @param [String] name # Required. # The resource name of the company to be deleted. diff --git a/generated/google/apis/language_v1.rb b/generated/google/apis/language_v1.rb index 9f634e22a..8188a9557 100644 --- a/generated/google/apis/language_v1.rb +++ b/generated/google/apis/language_v1.rb @@ -20,14 +20,14 @@ module Google module Apis # Cloud Natural Language API # - # Provides natural language understanding technologies to developers. Examples - # include sentiment analysis, entity recognition, entity sentiment analysis, and - # text annotations. + # Provides natural language understanding technologies, such as sentiment + # analysis, entity recognition, entity sentiment analysis, and other text + # annotations, to developers. # # @see https://cloud.google.com/natural-language/ module LanguageV1 VERSION = 'V1' - REVISION = '20180930' + REVISION = '20181022' # 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/service.rb b/generated/google/apis/language_v1/service.rb index fba03d509..863f33dc8 100644 --- a/generated/google/apis/language_v1/service.rb +++ b/generated/google/apis/language_v1/service.rb @@ -22,9 +22,9 @@ module Google module LanguageV1 # Cloud Natural Language API # - # Provides natural language understanding technologies to developers. Examples - # include sentiment analysis, entity recognition, entity sentiment analysis, and - # text annotations. + # Provides natural language understanding technologies, such as sentiment + # analysis, entity recognition, entity sentiment analysis, and other text + # annotations, to developers. # # @example # require 'google/apis/language_v1' diff --git a/generated/google/apis/language_v1beta1.rb b/generated/google/apis/language_v1beta1.rb index ec9d115fa..135a990f8 100644 --- a/generated/google/apis/language_v1beta1.rb +++ b/generated/google/apis/language_v1beta1.rb @@ -20,14 +20,14 @@ module Google module Apis # Cloud Natural Language API # - # Provides natural language understanding technologies to developers. Examples - # include sentiment analysis, entity recognition, entity sentiment analysis, and - # text annotations. + # Provides natural language understanding technologies, such as sentiment + # analysis, entity recognition, entity sentiment analysis, and other text + # annotations, to developers. # # @see https://cloud.google.com/natural-language/ module LanguageV1beta1 VERSION = 'V1beta1' - REVISION = '20180930' + REVISION = '20181022' # 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_v1beta1/service.rb b/generated/google/apis/language_v1beta1/service.rb index 24ae524b8..90651bb62 100644 --- a/generated/google/apis/language_v1beta1/service.rb +++ b/generated/google/apis/language_v1beta1/service.rb @@ -22,9 +22,9 @@ module Google module LanguageV1beta1 # Cloud Natural Language API # - # Provides natural language understanding technologies to developers. Examples - # include sentiment analysis, entity recognition, entity sentiment analysis, and - # text annotations. + # Provides natural language understanding technologies, such as sentiment + # analysis, entity recognition, entity sentiment analysis, and other text + # annotations, to developers. # # @example # require 'google/apis/language_v1beta1' diff --git a/generated/google/apis/language_v1beta2.rb b/generated/google/apis/language_v1beta2.rb index e6aff78d5..b0c017c87 100644 --- a/generated/google/apis/language_v1beta2.rb +++ b/generated/google/apis/language_v1beta2.rb @@ -20,14 +20,14 @@ module Google module Apis # Cloud Natural Language API # - # Provides natural language understanding technologies to developers. Examples - # include sentiment analysis, entity recognition, entity sentiment analysis, and - # text annotations. + # Provides natural language understanding technologies, such as sentiment + # analysis, entity recognition, entity sentiment analysis, and other text + # annotations, to developers. # # @see https://cloud.google.com/natural-language/ module LanguageV1beta2 VERSION = 'V1beta2' - REVISION = '20180930' + REVISION = '20181022' # 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/service.rb b/generated/google/apis/language_v1beta2/service.rb index d3f4e782c..487545f04 100644 --- a/generated/google/apis/language_v1beta2/service.rb +++ b/generated/google/apis/language_v1beta2/service.rb @@ -22,9 +22,9 @@ module Google module LanguageV1beta2 # Cloud Natural Language API # - # Provides natural language understanding technologies to developers. Examples - # include sentiment analysis, entity recognition, entity sentiment analysis, and - # text annotations. + # Provides natural language understanding technologies, such as sentiment + # analysis, entity recognition, entity sentiment analysis, and other text + # annotations, to developers. # # @example # require 'google/apis/language_v1beta2' diff --git a/generated/google/apis/logging_v2.rb b/generated/google/apis/logging_v2.rb index 2de3b7c7c..eae88889d 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 = '20181013' + REVISION = '20181020' # 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 ea8848317..dd80d75cc 100644 --- a/generated/google/apis/logging_v2/classes.rb +++ b/generated/google/apis/logging_v2/classes.rb @@ -1065,11 +1065,6 @@ module Google # @return [String] attr_accessor :destination - # Deprecated. This field is ignored when creating or updating sinks. - # Corresponds to the JSON property `endTime` - # @return [String] - attr_accessor :end_time - # Optional. An advanced logs filter. The only exported log entries are those # that are in the resource owning the sink and that match the filter. For # example: @@ -1109,11 +1104,6 @@ module Google # @return [String] attr_accessor :output_version_format - # Deprecated. This field is ignored when creating or updating sinks. - # Corresponds to the JSON property `startTime` - # @return [String] - attr_accessor :start_time - # Output only. An IAM identity—a service account or group—under # which Logging writes the exported log entries to the sink's destination. This # field is set by sinks.create and sinks.update, based on the setting of @@ -1133,12 +1123,10 @@ module Google # Update properties of this object def update!(**args) @destination = args[:destination] if args.key?(:destination) - @end_time = args[:end_time] if args.key?(:end_time) @filter = args[:filter] if args.key?(:filter) @include_children = args[:include_children] if args.key?(:include_children) @name = args[:name] if args.key?(:name) @output_version_format = args[:output_version_format] if args.key?(:output_version_format) - @start_time = args[:start_time] if args.key?(:start_time) @writer_identity = args[:writer_identity] if args.key?(:writer_identity) end end diff --git a/generated/google/apis/logging_v2/representations.rb b/generated/google/apis/logging_v2/representations.rb index 51f4f1241..6ca7d621c 100644 --- a/generated/google/apis/logging_v2/representations.rb +++ b/generated/google/apis/logging_v2/representations.rb @@ -434,12 +434,10 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :destination, as: 'destination' - property :end_time, as: 'endTime' property :filter, as: 'filter' property :include_children, as: 'includeChildren' property :name, as: 'name' property :output_version_format, as: 'outputVersionFormat' - property :start_time, as: 'startTime' property :writer_identity, as: 'writerIdentity' end end diff --git a/generated/google/apis/logging_v2beta1.rb b/generated/google/apis/logging_v2beta1.rb index 9cf85e8a2..34d3772f4 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 = '20181013' + REVISION = '20181020' # 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 cc018e9e2..58a7fab12 100644 --- a/generated/google/apis/logging_v2beta1/classes.rb +++ b/generated/google/apis/logging_v2beta1/classes.rb @@ -960,11 +960,6 @@ module Google # @return [String] attr_accessor :destination - # Deprecated. This field is ignored when creating or updating sinks. - # Corresponds to the JSON property `endTime` - # @return [String] - attr_accessor :end_time - # Optional. An advanced logs filter. The only exported log entries are those # that are in the resource owning the sink and that match the filter. For # example: @@ -1004,11 +999,6 @@ module Google # @return [String] attr_accessor :output_version_format - # Deprecated. This field is ignored when creating or updating sinks. - # Corresponds to the JSON property `startTime` - # @return [String] - attr_accessor :start_time - # Output only. An IAM identity—a service account or group—under # which Logging writes the exported log entries to the sink's destination. This # field is set by sinks.create and sinks.update, based on the setting of @@ -1028,12 +1018,10 @@ module Google # Update properties of this object def update!(**args) @destination = args[:destination] if args.key?(:destination) - @end_time = args[:end_time] if args.key?(:end_time) @filter = args[:filter] if args.key?(:filter) @include_children = args[:include_children] if args.key?(:include_children) @name = args[:name] if args.key?(:name) @output_version_format = args[:output_version_format] if args.key?(:output_version_format) - @start_time = args[:start_time] if args.key?(:start_time) @writer_identity = args[:writer_identity] if args.key?(:writer_identity) end end diff --git a/generated/google/apis/logging_v2beta1/representations.rb b/generated/google/apis/logging_v2beta1/representations.rb index fd2ff9678..50911f557 100644 --- a/generated/google/apis/logging_v2beta1/representations.rb +++ b/generated/google/apis/logging_v2beta1/representations.rb @@ -389,12 +389,10 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :destination, as: 'destination' - property :end_time, as: 'endTime' property :filter, as: 'filter' property :include_children, as: 'includeChildren' property :name, as: 'name' property :output_version_format, as: 'outputVersionFormat' - property :start_time, as: 'startTime' property :writer_identity, as: 'writerIdentity' end end diff --git a/generated/google/apis/monitoring_v3.rb b/generated/google/apis/monitoring_v3.rb index 92b80649f..0470cb248 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 = '20181009' + REVISION = '20181027' # 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 d2bafe33d..691e26d98 100644 --- a/generated/google/apis/monitoring_v3/classes.rb +++ b/generated/google/apis/monitoring_v3/classes.rb @@ -1199,8 +1199,8 @@ module Google end end - # Nimbus InternalCheckers. The API currently only allows reading of internal - # checkers, creation of internal checkers is a manual process. + # An internal checker allows uptime checks to run on private/internal GCP + # resources. class InternalChecker include Google::Apis::Core::Hashable @@ -1218,9 +1218,9 @@ module Google attr_accessor :gcp_zone # A unique resource name for this InternalChecker. The format is:projects/[ - # PROJECT_ID]/internalCheckers/[CHECKER_ID].PROJECT_ID is the GCP project ID - # where the internal resource lives. Not necessarily the same as the project_id - # for the config. + # PROJECT_ID]/internalCheckers/[INTERNAL_CHECKER_ID].PROJECT_ID is the + # stackdriver workspace project for the uptime check config associated with the + # internal checker. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1231,6 +1231,12 @@ module Google # @return [String] attr_accessor :network + # The GCP project_id where the internal checker lives. Not necessary the same as + # the workspace project. + # Corresponds to the JSON property `peerProjectId` + # @return [String] + attr_accessor :peer_project_id + def initialize(**args) update!(**args) end @@ -1241,6 +1247,7 @@ module Google @gcp_zone = args[:gcp_zone] if args.key?(:gcp_zone) @name = args[:name] if args.key?(:name) @network = args[:network] if args.key?(:network) + @peer_project_id = args[:peer_project_id] if args.key?(:peer_project_id) end end @@ -2808,13 +2815,16 @@ module Google attr_accessor :http_check # The internal checkers that this check will egress from. If is_internal is true - # and this list is empty, the check will egress from all InternalCheckers + # and this list is empty, the check will egress from all the InternalCheckers # configured for the project that owns this CheckConfig. # Corresponds to the JSON property `internalCheckers` # @return [Array] attr_accessor :internal_checkers - # Denotes whether this is a check that egresses from InternalCheckers. + # If this is true, then checks are made only from the 'internal_checkers'. If it + # is false, then checks are made only from the 'selected_regions'. It is an + # error to provide 'selected_regions' when is_internal is true, or to provide ' + # internal_checkers' when is_internal is false. # Corresponds to the JSON property `isInternal` # @return [Boolean] attr_accessor :is_internal @@ -2857,10 +2867,11 @@ module Google # @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. + # The list of regions from which the check will be run. Some regions contain one + # location, and others contain more than one. 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 diff --git a/generated/google/apis/monitoring_v3/representations.rb b/generated/google/apis/monitoring_v3/representations.rb index 67d5b172c..fa3bd5e7b 100644 --- a/generated/google/apis/monitoring_v3/representations.rb +++ b/generated/google/apis/monitoring_v3/representations.rb @@ -685,6 +685,7 @@ module Google property :gcp_zone, as: 'gcpZone' property :name, as: 'name' property :network, as: 'network' + property :peer_project_id, as: 'peerProjectId' end end diff --git a/generated/google/apis/monitoring_v3/service.rb b/generated/google/apis/monitoring_v3/service.rb index cb0147b4e..860cd74ab 100644 --- a/generated/google/apis/monitoring_v3/service.rb +++ b/generated/google/apis/monitoring_v3/service.rb @@ -49,6 +49,231 @@ module Google @batch_path = 'batch' end + # Creates a new metric descriptor. User-created metric descriptors define custom + # metrics. + # @param [String] name + # The project on which to execute the request. The format is "projects/` + # project_id_or_number`". + # @param [Google::Apis::MonitoringV3::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. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::MonitoringV3::MetricDescriptor] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MonitoringV3::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(name, metric_descriptor_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3/{+name}/metricDescriptors', options) + command.request_representation = Google::Apis::MonitoringV3::MetricDescriptor::Representation + command.request_object = metric_descriptor_object + command.response_representation = Google::Apis::MonitoringV3::MetricDescriptor::Representation + command.response_class = Google::Apis::MonitoringV3::MetricDescriptor + 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 metric descriptor. Only user-created custom metrics can be deleted. + # @param [String] name + # The metric descriptor on which to execute the request. The format is "projects/ + # `project_id_or_number`/metricDescriptors/`metric_id`". An example of ` + # metric_id` is: "custom.googleapis.com/my_test_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. + # @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_metric_descriptor(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 metric descriptor. This method does not require a Stackdriver + # account. + # @param [String] name + # The metric descriptor on which to execute the request. The format is "projects/ + # `project_id_or_number`/metricDescriptors/`metric_id`". An example value of ` + # metric_id` is "compute.googleapis.com/instance/disk/read_bytes_count". + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::MetricDescriptor] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MonitoringV3::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 get_metric_descriptor(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/{+name}', options) + command.response_representation = Google::Apis::MonitoringV3::MetricDescriptor::Representation + command.response_class = Google::Apis::MonitoringV3::MetricDescriptor + 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 metric descriptors that match a filter. This method does not require a + # Stackdriver account. + # @param [String] name + # The project on which to execute the request. The format is "projects/` + # project_id_or_number`". + # @param [String] filter + # If this field is empty, all custom and system-defined metric descriptors are + # returned. Otherwise, the filter specifies which metric descriptors are to be + # returned. For example, the following filter matches all custom metrics: + # metric.type = starts_with("custom.googleapis.com/") + # @param [Fixnum] page_size + # A positive number that is the maximum number of results to return. + # @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 additional 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::ListMetricDescriptorsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MonitoringV3::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(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/{+name}/metricDescriptors', options) + command.response_representation = Google::Apis::MonitoringV3::ListMetricDescriptorsResponse::Representation + command.response_class = Google::Apis::MonitoringV3::ListMetricDescriptorsResponse + 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 + + # Gets a single monitored resource descriptor. This method does not require a + # Stackdriver account. + # @param [String] name + # The monitored resource descriptor to get. The format is "projects/` + # project_id_or_number`/monitoredResourceDescriptors/`resource_type`". The ` + # resource_type` is a predefined type, such as cloudsql_database. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::MonitoredResourceDescriptor] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MonitoringV3::MonitoredResourceDescriptor] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_monitored_resource_descriptor(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/{+name}', options) + command.response_representation = Google::Apis::MonitoringV3::MonitoredResourceDescriptor::Representation + command.response_class = Google::Apis::MonitoringV3::MonitoredResourceDescriptor + 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 monitored resource descriptors that match a filter. This method does not + # require a Stackdriver account. + # @param [String] name + # The project on which to execute the request. The format is "projects/` + # project_id_or_number`". + # @param [String] filter + # An optional filter describing the descriptors to be returned. The filter can + # reference the descriptor's type and labels. For example, the following filter + # returns only Google Compute Engine descriptors that have an id label: + # resource.type = starts_with("gce_") AND resource.label:id + # @param [Fixnum] page_size + # A positive number that is the maximum number of results to return. + # @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 additional 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::ListMonitoredResourceDescriptorsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MonitoringV3::ListMonitoredResourceDescriptorsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_monitored_resource_descriptors(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/{+name}/monitoredResourceDescriptors', options) + command.response_representation = Google::Apis::MonitoringV3::ListMonitoredResourceDescriptorsResponse::Representation + command.response_class = Google::Apis::MonitoringV3::ListMonitoredResourceDescriptorsResponse + 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 new alerting policy. # @param [String] name # The project in which to create the alerting policy. The format is projects/[ @@ -1193,7 +1418,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_time_series(name, create_time_series_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + def create_project_time_series(name, create_time_series_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/{+name}/timeSeries', options) command.request_representation = Google::Apis::MonitoringV3::CreateTimeSeriesRequest::Representation command.request_object = create_time_series_request_object @@ -1495,6 +1720,146 @@ module Google execute_or_queue_command(command, &block) end + # Creates or adds data to one or more time series. The response is empty if all + # time series in the request were written. If any time series could not be + # written, a corresponding failure message is included in the error response. + # @param [String] name + # The project on which to execute the request. The format is "projects/` + # project_id_or_number`". + # @param [Google::Apis::MonitoringV3::CreateTimeSeriesRequest] create_time_series_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::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 create_time_series(name, create_time_series_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3/{+name}/timeSeries', options) + command.request_representation = Google::Apis::MonitoringV3::CreateTimeSeriesRequest::Representation + command.request_object = create_time_series_request_object + 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 + + # Lists time series that match a filter. This method does not require a + # Stackdriver account. + # @param [String] name + # The project on which to execute the request. The format is "projects/` + # project_id_or_number`". + # @param [String] aggregation_alignment_period + # The alignment period for per-time series alignment. If present, + # alignmentPeriod must be at least 60 seconds. After per-time series alignment, + # each time series will contain data points only on the period boundaries. If + # perSeriesAligner is not specified or equals ALIGN_NONE, then this field is + # ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then + # this field must be defined; otherwise an error is returned. + # @param [String] aggregation_cross_series_reducer + # The approach to be used to combine time series. Not all reducer functions may + # be applied to all time series, depending on the metric type and the value type + # of the original time series. Reduction may change the metric type of value + # type of the time series.Time series data must be aligned in order to perform + # cross-time series reduction. If crossSeriesReducer is specified, then + # perSeriesAligner must be specified and not equal ALIGN_NONE and + # alignmentPeriod must be specified; otherwise, an error is returned. + # @param [Array, String] aggregation_group_by_fields + # The set of fields to preserve when crossSeriesReducer is specified. The + # groupByFields determine how the time series are partitioned into subsets prior + # to applying the aggregation function. Each subset contains time series that + # have the same value for each of the grouping fields. Each individual time + # series is a member of exactly one subset. The crossSeriesReducer is applied to + # each subset of time series. It is not possible to reduce across different + # resource types, so this field implicitly contains resource.type. Fields not + # specified in groupByFields are aggregated away. If groupByFields is not + # specified and all the time series have the same resource type, then the time + # series are aggregated into a single output time series. If crossSeriesReducer + # is not defined, this field is ignored. + # @param [String] aggregation_per_series_aligner + # The approach to be used to align individual time series. Not all alignment + # functions may be applied to all time series, depending on the metric type and + # value type of the original time series. Alignment may change the metric type + # or the value type of the time series.Time series data must be aligned in order + # to perform cross-time series reduction. If crossSeriesReducer is specified, + # then perSeriesAligner must be specified and not equal ALIGN_NONE and + # alignmentPeriod must be specified; otherwise, an error is returned. + # @param [String] filter + # A monitoring filter that specifies which time series should be returned. The + # filter must specify a single metric type, and can additionally specify metric + # labels and other information. For example: + # metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND + # metric.label.instance_name = "my-instance-name" + # @param [String] interval_end_time + # Required. The end of the time interval. + # @param [String] interval_start_time + # Optional. The beginning of the time interval. The default value for the start + # time is the end time. The start time must not be later than the end time. + # @param [String] order_by + # Unsupported: must be left blank. The points in each time series are returned + # in reverse time order. + # @param [Fixnum] page_size + # A positive number that is the maximum number of results to return. If + # page_size is empty or more than 100,000 results, the effective page_size is + # 100,000 results. If view is set to FULL, this is the maximum number of Points + # returned. If view is set to HEADERS, this is the maximum number of TimeSeries + # 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 additional results from the previous method call. + # @param [String] view + # Specifies which information is returned about the time series. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::ListTimeSeriesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::MonitoringV3::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_time_series(name, aggregation_alignment_period: nil, aggregation_cross_series_reducer: nil, aggregation_group_by_fields: nil, aggregation_per_series_aligner: nil, filter: nil, interval_end_time: nil, interval_start_time: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3/{+name}/timeSeries', options) + command.response_representation = Google::Apis::MonitoringV3::ListTimeSeriesResponse::Representation + command.response_class = Google::Apis::MonitoringV3::ListTimeSeriesResponse + command.params['name'] = name unless name.nil? + command.query['aggregation.alignmentPeriod'] = aggregation_alignment_period unless aggregation_alignment_period.nil? + command.query['aggregation.crossSeriesReducer'] = aggregation_cross_series_reducer unless aggregation_cross_series_reducer.nil? + command.query['aggregation.groupByFields'] = aggregation_group_by_fields unless aggregation_group_by_fields.nil? + command.query['aggregation.perSeriesAligner'] = aggregation_per_series_aligner unless aggregation_per_series_aligner.nil? + command.query['filter'] = filter unless filter.nil? + command.query['interval.endTime'] = interval_end_time unless interval_end_time.nil? + command.query['interval.startTime'] = interval_start_time unless interval_start_time.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['view'] = view unless view.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 diff --git a/generated/google/apis/oslogin_v1.rb b/generated/google/apis/oslogin_v1.rb index 883f86695..fe61e6de9 100644 --- a/generated/google/apis/oslogin_v1.rb +++ b/generated/google/apis/oslogin_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/compute/docs/oslogin/rest/ module OsloginV1 VERSION = 'V1' - REVISION = '20180617' + REVISION = '20181023' # 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_v1/service.rb b/generated/google/apis/oslogin_v1/service.rb index 5238180e6..eb6804730 100644 --- a/generated/google/apis/oslogin_v1/service.rb +++ b/generated/google/apis/oslogin_v1/service.rb @@ -51,6 +51,10 @@ module Google # on Google Compute Engine. # @param [String] name # The unique ID for the user in format `users/`user``. + # @param [String] project_id + # The project ID of the Google Cloud Platform project. + # @param [String] system_id + # A system ID for filtering the results of the request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -68,11 +72,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 get_user_login_profile(name, fields: nil, quota_user: nil, options: nil, &block) + def get_user_login_profile(name, project_id: nil, system_id: nil, 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['projectId'] = project_id unless project_id.nil? + command.query['systemId'] = system_id unless system_id.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_v1alpha.rb b/generated/google/apis/oslogin_v1alpha.rb index c1bfa66f7..62a8b7aff 100644 --- a/generated/google/apis/oslogin_v1alpha.rb +++ b/generated/google/apis/oslogin_v1alpha.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/compute/docs/oslogin/rest/ module OsloginV1alpha VERSION = 'V1alpha' - REVISION = '20180617' + REVISION = '20181023' # 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/service.rb b/generated/google/apis/oslogin_v1alpha/service.rb index 950633a59..a8c76ac31 100644 --- a/generated/google/apis/oslogin_v1alpha/service.rb +++ b/generated/google/apis/oslogin_v1alpha/service.rb @@ -51,6 +51,12 @@ module Google # on Google Compute Engine. # @param [String] name # The unique ID for the user in format `users/`user``. + # @param [String] operating_system_type + # The type of operating system associated with the account. + # @param [String] project_id + # The project ID of the Google Cloud Platform project. + # @param [String] system_id + # A system ID for filtering the results of the request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -68,11 +74,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_user_login_profile(name, fields: nil, quota_user: nil, options: nil, &block) + def get_user_login_profile(name, operating_system_type: nil, project_id: nil, system_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1alpha/{+name}/loginProfile', options) command.response_representation = Google::Apis::OsloginV1alpha::LoginProfile::Representation command.response_class = Google::Apis::OsloginV1alpha::LoginProfile command.params['name'] = name unless name.nil? + command.query['operatingSystemType'] = operating_system_type unless operating_system_type.nil? + command.query['projectId'] = project_id unless project_id.nil? + command.query['systemId'] = system_id unless system_id.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 470004077..7d4ed5c86 100644 --- a/generated/google/apis/oslogin_v1beta.rb +++ b/generated/google/apis/oslogin_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/compute/docs/oslogin/rest/ module OsloginV1beta VERSION = 'V1beta' - REVISION = '20180617' + REVISION = '20181023' # 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/service.rb b/generated/google/apis/oslogin_v1beta/service.rb index 05fa7fd67..e469dec56 100644 --- a/generated/google/apis/oslogin_v1beta/service.rb +++ b/generated/google/apis/oslogin_v1beta/service.rb @@ -51,6 +51,10 @@ module Google # on Google Compute Engine. # @param [String] name # The unique ID for the user in format `users/`user``. + # @param [String] project_id + # The project ID of the Google Cloud Platform project. + # @param [String] system_id + # A system ID for filtering the results of the request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -68,11 +72,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 get_user_login_profile(name, fields: nil, quota_user: nil, options: nil, &block) + def get_user_login_profile(name, project_id: nil, system_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+name}/loginProfile', options) command.response_representation = Google::Apis::OsloginV1beta::LoginProfile::Representation command.response_class = Google::Apis::OsloginV1beta::LoginProfile command.params['name'] = name unless name.nil? + command.query['projectId'] = project_id unless project_id.nil? + command.query['systemId'] = system_id unless system_id.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/redis_v1.rb b/generated/google/apis/redis_v1.rb index 42f1516bb..037b793c9 100644 --- a/generated/google/apis/redis_v1.rb +++ b/generated/google/apis/redis_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/memorystore/docs/redis/ module RedisV1 VERSION = 'V1' - REVISION = '20180927' + REVISION = '20181031' # 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/redis_v1/classes.rb b/generated/google/apis/redis_v1/classes.rb index 31288931c..9e86714a8 100644 --- a/generated/google/apis/redis_v1/classes.rb +++ b/generated/google/apis/redis_v1/classes.rb @@ -306,6 +306,11 @@ module Google # @return [String] attr_accessor :next_page_token + # Locations that could not be reached. + # Corresponds to the JSON property `unreachable` + # @return [Array] + attr_accessor :unreachable + def initialize(**args) update!(**args) end @@ -314,6 +319,7 @@ module Google def update!(**args) @instances = args[:instances] if args.key?(:instances) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @unreachable = args[:unreachable] if args.key?(:unreachable) end end diff --git a/generated/google/apis/redis_v1/representations.rb b/generated/google/apis/redis_v1/representations.rb index 0d021c851..b137cc85f 100644 --- a/generated/google/apis/redis_v1/representations.rb +++ b/generated/google/apis/redis_v1/representations.rb @@ -150,6 +150,7 @@ module Google collection :instances, as: 'instances', class: Google::Apis::RedisV1::Instance, decorator: Google::Apis::RedisV1::Instance::Representation property :next_page_token, as: 'nextPageToken' + collection :unreachable, as: 'unreachable' end end diff --git a/generated/google/apis/redis_v1beta1.rb b/generated/google/apis/redis_v1beta1.rb index b579caab6..f24fd9dbf 100644 --- a/generated/google/apis/redis_v1beta1.rb +++ b/generated/google/apis/redis_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/memorystore/docs/redis/ module RedisV1beta1 VERSION = 'V1beta1' - REVISION = '20180830' + REVISION = '20181031' # 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/redis_v1beta1/classes.rb b/generated/google/apis/redis_v1beta1/classes.rb index aebb8ddd8..077049b80 100644 --- a/generated/google/apis/redis_v1beta1/classes.rb +++ b/generated/google/apis/redis_v1beta1/classes.rb @@ -318,6 +318,11 @@ module Google # @return [String] attr_accessor :next_page_token + # Locations that could not be reached. + # Corresponds to the JSON property `unreachable` + # @return [Array] + attr_accessor :unreachable + def initialize(**args) update!(**args) end @@ -326,6 +331,7 @@ module Google def update!(**args) @instances = args[:instances] if args.key?(:instances) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @unreachable = args[:unreachable] if args.key?(:unreachable) end end diff --git a/generated/google/apis/redis_v1beta1/representations.rb b/generated/google/apis/redis_v1beta1/representations.rb index 55e24536b..8d4501285 100644 --- a/generated/google/apis/redis_v1beta1/representations.rb +++ b/generated/google/apis/redis_v1beta1/representations.rb @@ -151,6 +151,7 @@ module Google collection :instances, as: 'instances', class: Google::Apis::RedisV1beta1::Instance, decorator: Google::Apis::RedisV1beta1::Instance::Representation property :next_page_token, as: 'nextPageToken' + collection :unreachable, as: 'unreachable' end end diff --git a/generated/google/apis/runtimeconfig_v1beta1.rb b/generated/google/apis/runtimeconfig_v1beta1.rb index 1311758e2..ee69b57ba 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 = '20180806' + REVISION = '20181022' # 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 f5b5798d3..06c7a27c6 100644 --- a/generated/google/apis/runtimeconfig_v1beta1/classes.rb +++ b/generated/google/apis/runtimeconfig_v1beta1/classes.rb @@ -73,13 +73,13 @@ module Google # A Cardinality condition for the Waiter resource. A cardinality condition is # met when the number of variables under a specified path prefix reaches a # predefined number. For example, if you set a Cardinality condition where - # the `path` is set to `/foo` and the number of paths is set to 2, the + # the `path` is set to `/foo` and the number of paths is set to `2`, the # following variables would meet the condition in a RuntimeConfig resource: # + `/foo/variable1 = "value1"` # + `/foo/variable2 = "value2"` # + `/bar/variable3 = "value3"` - # It would not would not satisify the same condition with the `number` set to - # 3, however, because there is only 2 paths that start with `/foo`. + # It would not satisfy the same condition with the `number` set to + # `3`, however, because there is only 2 paths that start with `/foo`. # Cardinality conditions are recursive; all subtrees under the specific # path prefix are counted. class Cardinality @@ -133,13 +133,13 @@ module Google # A Cardinality condition for the Waiter resource. A cardinality condition is # met when the number of variables under a specified path prefix reaches a # predefined number. For example, if you set a Cardinality condition where - # the `path` is set to `/foo` and the number of paths is set to 2, the + # the `path` is set to `/foo` and the number of paths is set to `2`, the # following variables would meet the condition in a RuntimeConfig resource: # + `/foo/variable1 = "value1"` # + `/foo/variable2 = "value2"` # + `/bar/variable3 = "value3"` - # It would not would not satisify the same condition with the `number` set to - # 3, however, because there is only 2 paths that start with `/foo`. + # It would not satisfy the same condition with the `number` set to + # `3`, however, because there is only 2 paths that start with `/foo`. # Cardinality conditions are recursive; all subtrees under the specific # path prefix are counted. # Corresponds to the JSON property `cardinality` @@ -712,6 +712,7 @@ module Google attr_accessor :text # Output only. The time of the last variable update. + # Timestamp will be UTC timestamp. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time diff --git a/generated/google/apis/serviceconsumermanagement_v1.rb b/generated/google/apis/serviceconsumermanagement_v1.rb index 8d7b2df81..c7307f777 100644 --- a/generated/google/apis/serviceconsumermanagement_v1.rb +++ b/generated/google/apis/serviceconsumermanagement_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/service-consumer-management/docs/overview module ServiceconsumermanagementV1 VERSION = 'V1' - REVISION = '20181009' + REVISION = '20181030' # 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/serviceconsumermanagement_v1/classes.rb b/generated/google/apis/serviceconsumermanagement_v1/classes.rb index 00f6e596f..ed73b6849 100644 --- a/generated/google/apis/serviceconsumermanagement_v1/classes.rb +++ b/generated/google/apis/serviceconsumermanagement_v1/classes.rb @@ -411,6 +411,12 @@ module Google # @return [Float] attr_accessor :min_deadline + # The number of seconds to wait for the completion of a long running + # operation. The default is no deadline. + # Corresponds to the JSON property `operationDeadline` + # @return [Float] + attr_accessor :operation_deadline + # Selects the methods to which this rule applies. # Refer to selector for syntax details. # Corresponds to the JSON property `selector` @@ -426,6 +432,7 @@ module Google @address = args[:address] if args.key?(:address) @deadline = args[:deadline] if args.key?(:deadline) @min_deadline = args[:min_deadline] if args.key?(:min_deadline) + @operation_deadline = args[:operation_deadline] if args.key?(:operation_deadline) @selector = args[:selector] if args.key?(:selector) end end diff --git a/generated/google/apis/serviceconsumermanagement_v1/representations.rb b/generated/google/apis/serviceconsumermanagement_v1/representations.rb index 87621bdfb..334100aef 100644 --- a/generated/google/apis/serviceconsumermanagement_v1/representations.rb +++ b/generated/google/apis/serviceconsumermanagement_v1/representations.rb @@ -518,6 +518,7 @@ module Google property :address, as: 'address' property :deadline, as: 'deadline' property :min_deadline, as: 'minDeadline' + property :operation_deadline, as: 'operationDeadline' property :selector, as: 'selector' end end diff --git a/generated/google/apis/servicecontrol_v1.rb b/generated/google/apis/servicecontrol_v1.rb index 64b998aef..30b53dc58 100644 --- a/generated/google/apis/servicecontrol_v1.rb +++ b/generated/google/apis/servicecontrol_v1.rb @@ -20,13 +20,13 @@ module Google module Apis # Service Control API # - # Google Service Control provides control plane functionality to managed - # services, such as logging, monitoring, and status checks. + # Provides control plane functionality to managed services, such as logging, + # monitoring, and status checks. # # @see https://cloud.google.com/service-control/ module ServicecontrolV1 VERSION = 'V1' - REVISION = '20181008' + REVISION = '20181029' # 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 065af685c..278221ee8 100644 --- a/generated/google/apis/servicecontrol_v1/classes.rb +++ b/generated/google/apis/servicecontrol_v1/classes.rb @@ -489,7 +489,7 @@ module Google class CheckInfo include Google::Apis::Core::Hashable - # `ConsumerInfo` provides information about the consumer project. + # `ConsumerInfo` provides information about the consumer. # Corresponds to the JSON property `consumerInfo` # @return [Google::Apis::ServicecontrolV1::ConsumerInfo] attr_accessor :consumer_info @@ -602,23 +602,39 @@ module Google end end - # `ConsumerInfo` provides information about the consumer project. + # `ConsumerInfo` provides information about the consumer. class ConsumerInfo include Google::Apis::Core::Hashable + # The consumer identity number, can be Google cloud project number, folder + # number or organization number e.g. 1234567890. A value of 0 indicates no + # consumer number is found. + # Corresponds to the JSON property `consumerNumber` + # @return [Fixnum] + attr_accessor :consumer_number + # The Google cloud project number, e.g. 1234567890. A value of 0 indicates # no project number is found. + # NOTE: This field is deprecated after Chemist support flexible consumer + # id. New code should not depend on this field anymore. # Corresponds to the JSON property `projectNumber` # @return [Fixnum] attr_accessor :project_number + # + # 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) + @consumer_number = args[:consumer_number] if args.key?(:consumer_number) @project_number = args[:project_number] if args.key?(:project_number) + @type = args[:type] if args.key?(:type) end end @@ -707,87 +723,6 @@ module Google end end - # Request message for QuotaController.EndReconciliation. - class EndReconciliationRequest - include Google::Apis::Core::Hashable - - # Represents information regarding a quota operation. - # Corresponds to the JSON property `reconciliationOperation` - # @return [Google::Apis::ServicecontrolV1::QuotaOperation] - attr_accessor :reconciliation_operation - - # Specifies which version of service configuration should be used to process - # the request. If unspecified or no matching version can be found, the latest - # one will be used. - # Corresponds to the JSON property `serviceConfigId` - # @return [String] - attr_accessor :service_config_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @reconciliation_operation = args[:reconciliation_operation] if args.key?(:reconciliation_operation) - @service_config_id = args[:service_config_id] if args.key?(:service_config_id) - end - end - - # Response message for QuotaController.EndReconciliation. - class EndReconciliationResponse - include Google::Apis::Core::Hashable - - # The same operation_id value used in the EndReconciliationRequest. Used for - # logging and diagnostics purposes. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # Metric values as tracked by One Platform before the adjustment was made. - # The following metrics will be included: - # 1. Per quota metric total usage will be specified using the following gauge - # metric: - # "serviceruntime.googleapis.com/allocation/consumer/quota_used_count" - # 2. Value for each quota limit associated with the metrics will be specified - # using the following gauge metric: - # "serviceruntime.googleapis.com/quota/limit" - # 3. Delta value of the usage after the reconciliation for limits associated - # with the metrics will be specified using the following metric: - # "serviceruntime.googleapis.com/allocation/reconciliation_delta" - # The delta value is defined as: - # new_usage_from_client - existing_value_in_spanner. - # This metric is not defined in serviceruntime.yaml or in Cloud Monarch. - # This metric is meant for callers' use only. Since this metric is not - # defined in the monitoring backend, reporting on this metric will result in - # an error. - # Corresponds to the JSON property `quotaMetrics` - # @return [Array] - attr_accessor :quota_metrics - - # Indicates the decision of the reconciliation end. - # Corresponds to the JSON property `reconciliationErrors` - # @return [Array] - attr_accessor :reconciliation_errors - - # ID of the actual config used to process the request. - # Corresponds to the JSON property `serviceConfigId` - # @return [String] - attr_accessor :service_config_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) - @quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics) - @reconciliation_errors = args[:reconciliation_errors] if args.key?(:reconciliation_errors) - @service_config_id = args[:service_config_id] if args.key?(:service_config_id) - end - end - # Describing buckets with arbitrary user-provided width. class ExplicitBuckets include Google::Apis::Core::Hashable @@ -1672,81 +1607,6 @@ module Google end end - # Request message for the ReleaseQuota method. - class ReleaseQuotaRequest - include Google::Apis::Core::Hashable - - # Represents information regarding a quota operation. - # Corresponds to the JSON property `releaseOperation` - # @return [Google::Apis::ServicecontrolV1::QuotaOperation] - attr_accessor :release_operation - - # Specifies which version of service configuration should be used to process - # the request. If unspecified or no matching version can be found, the latest - # one will be used. - # Corresponds to the JSON property `serviceConfigId` - # @return [String] - attr_accessor :service_config_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @release_operation = args[:release_operation] if args.key?(:release_operation) - @service_config_id = args[:service_config_id] if args.key?(:service_config_id) - end - end - - # Response message for the ReleaseQuota method. - class ReleaseQuotaResponse - include Google::Apis::Core::Hashable - - # The same operation_id value used in the ReleaseQuotaRequest. Used for - # logging and diagnostics purposes. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # Quota metrics to indicate the result of release. Depending on the - # request, one or more of the following metrics will be included: - # 1. For rate quota, per quota group or per quota metric released amount - # will be specified using the following delta metric: - # "serviceruntime.googleapis.com/api/consumer/quota_refund_count" - # 2. For allocation quota, per quota metric total usage will be specified - # using the following gauge metric: - # "serviceruntime.googleapis.com/allocation/consumer/quota_used_count" - # 3. For allocation quota, value for each quota limit associated with - # the metrics will be specified using the following gauge metric: - # "serviceruntime.googleapis.com/quota/limit" - # Corresponds to the JSON property `quotaMetrics` - # @return [Array] - attr_accessor :quota_metrics - - # Indicates the decision of the release. - # Corresponds to the JSON property `releaseErrors` - # @return [Array] - attr_accessor :release_errors - - # ID of the actual config used to process the request. - # Corresponds to the JSON property `serviceConfigId` - # @return [String] - attr_accessor :service_config_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) - @quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics) - @release_errors = args[:release_errors] if args.key?(:release_errors) - @service_config_id = args[:service_config_id] if args.key?(:service_config_id) - end - end - # Represents the processing error of one Operation in the request. class ReportError include Google::Apis::Core::Hashable @@ -2217,78 +2077,6 @@ module Google end end - # Request message for QuotaController.StartReconciliation. - class StartReconciliationRequest - include Google::Apis::Core::Hashable - - # Represents information regarding a quota operation. - # Corresponds to the JSON property `reconciliationOperation` - # @return [Google::Apis::ServicecontrolV1::QuotaOperation] - attr_accessor :reconciliation_operation - - # Specifies which version of service configuration should be used to process - # the request. If unspecified or no matching version can be found, the latest - # one will be used. - # Corresponds to the JSON property `serviceConfigId` - # @return [String] - attr_accessor :service_config_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @reconciliation_operation = args[:reconciliation_operation] if args.key?(:reconciliation_operation) - @service_config_id = args[:service_config_id] if args.key?(:service_config_id) - end - end - - # Response message for QuotaController.StartReconciliation. - class StartReconciliationResponse - include Google::Apis::Core::Hashable - - # The same operation_id value used in the StartReconciliationRequest. Used - # for logging and diagnostics purposes. - # Corresponds to the JSON property `operationId` - # @return [String] - attr_accessor :operation_id - - # Metric values as tracked by One Platform before the start of - # reconciliation. The following metrics will be included: - # 1. Per quota metric total usage will be specified using the following gauge - # metric: - # "serviceruntime.googleapis.com/allocation/consumer/quota_used_count" - # 2. Value for each quota limit associated with the metrics will be specified - # using the following gauge metric: - # "serviceruntime.googleapis.com/quota/limit" - # Corresponds to the JSON property `quotaMetrics` - # @return [Array] - attr_accessor :quota_metrics - - # Indicates the decision of the reconciliation start. - # Corresponds to the JSON property `reconciliationErrors` - # @return [Array] - attr_accessor :reconciliation_errors - - # ID of the actual config used to process the request. - # Corresponds to the JSON property `serviceConfigId` - # @return [String] - attr_accessor :service_config_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) - @quota_metrics = args[:quota_metrics] if args.key?(:quota_metrics) - @reconciliation_errors = args[:reconciliation_errors] if args.key?(:reconciliation_errors) - @service_config_id = args[:service_config_id] if args.key?(:service_config_id) - 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/servicecontrol_v1/representations.rb b/generated/google/apis/servicecontrol_v1/representations.rb index 4d124d42e..bf754fe73 100644 --- a/generated/google/apis/servicecontrol_v1/representations.rb +++ b/generated/google/apis/servicecontrol_v1/representations.rb @@ -100,18 +100,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class EndReconciliationRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class EndReconciliationResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class ExplicitBuckets class Representation < Google::Apis::Core::JsonRepresentation; end @@ -202,18 +190,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ReleaseQuotaRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ReleaseQuotaResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class ReportError class Representation < Google::Apis::Core::JsonRepresentation; end @@ -268,18 +244,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class StartReconciliationRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class StartReconciliationResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class Status class Representation < Google::Apis::Core::JsonRepresentation; end @@ -418,7 +382,9 @@ module Google class ConsumerInfo # @private class Representation < Google::Apis::Core::JsonRepresentation + property :consumer_number, :numeric_string => true, as: 'consumerNumber' property :project_number, :numeric_string => true, as: 'projectNumber' + property :type, as: 'type' end end @@ -440,27 +406,6 @@ module Google end end - class EndReconciliationRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :reconciliation_operation, as: 'reconciliationOperation', class: Google::Apis::ServicecontrolV1::QuotaOperation, decorator: Google::Apis::ServicecontrolV1::QuotaOperation::Representation - - property :service_config_id, as: 'serviceConfigId' - end - end - - class EndReconciliationResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :operation_id, as: 'operationId' - collection :quota_metrics, as: 'quotaMetrics', class: Google::Apis::ServicecontrolV1::MetricValueSet, decorator: Google::Apis::ServicecontrolV1::MetricValueSet::Representation - - collection :reconciliation_errors, as: 'reconciliationErrors', class: Google::Apis::ServicecontrolV1::QuotaError, decorator: Google::Apis::ServicecontrolV1::QuotaError::Representation - - property :service_config_id, as: 'serviceConfigId' - end - end - class ExplicitBuckets # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -645,27 +590,6 @@ module Google end end - class ReleaseQuotaRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :release_operation, as: 'releaseOperation', class: Google::Apis::ServicecontrolV1::QuotaOperation, decorator: Google::Apis::ServicecontrolV1::QuotaOperation::Representation - - property :service_config_id, as: 'serviceConfigId' - end - end - - class ReleaseQuotaResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :operation_id, as: 'operationId' - collection :quota_metrics, as: 'quotaMetrics', class: Google::Apis::ServicecontrolV1::MetricValueSet, decorator: Google::Apis::ServicecontrolV1::MetricValueSet::Representation - - collection :release_errors, as: 'releaseErrors', class: Google::Apis::ServicecontrolV1::QuotaError, decorator: Google::Apis::ServicecontrolV1::QuotaError::Representation - - property :service_config_id, as: 'serviceConfigId' - end - end - class ReportError # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -764,27 +688,6 @@ module Google end end - class StartReconciliationRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :reconciliation_operation, as: 'reconciliationOperation', class: Google::Apis::ServicecontrolV1::QuotaOperation, decorator: Google::Apis::ServicecontrolV1::QuotaOperation::Representation - - property :service_config_id, as: 'serviceConfigId' - end - end - - class StartReconciliationResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :operation_id, as: 'operationId' - collection :quota_metrics, as: 'quotaMetrics', class: Google::Apis::ServicecontrolV1::MetricValueSet, decorator: Google::Apis::ServicecontrolV1::MetricValueSet::Representation - - collection :reconciliation_errors, as: 'reconciliationErrors', class: Google::Apis::ServicecontrolV1::QuotaError, decorator: Google::Apis::ServicecontrolV1::QuotaError::Representation - - property :service_config_id, as: 'serviceConfigId' - end - end - class Status # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/servicecontrol_v1/service.rb b/generated/google/apis/servicecontrol_v1/service.rb index 5d0f3ceff..035a50d00 100644 --- a/generated/google/apis/servicecontrol_v1/service.rb +++ b/generated/google/apis/servicecontrol_v1/service.rb @@ -22,8 +22,8 @@ module Google module ServicecontrolV1 # Service Control API # - # Google Service Control provides control plane functionality to managed - # services, such as logging, monitoring, and status checks. + # Provides control plane functionality to managed services, such as logging, + # monitoring, and status checks. # # @example # require 'google/apis/servicecontrol_v1' @@ -141,87 +141,6 @@ module Google execute_or_queue_command(command, &block) end - # Signals the quota controller that service ends the ongoing usage - # reconciliation. - # This method requires the `servicemanagement.services.quota` - # permission on the specified service. For more information, see - # [Google Cloud IAM](https://cloud.google.com/iam). - # @param [String] service_name - # Name of the service as specified in the service configuration. For example, - # `"pubsub.googleapis.com"`. - # See google.api.Service for the definition of a service name. - # @param [Google::Apis::ServicecontrolV1::EndReconciliationRequest] end_reconciliation_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::ServicecontrolV1::EndReconciliationResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ServicecontrolV1::EndReconciliationResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def end_service_reconciliation(service_name, end_reconciliation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1/services/{serviceName}:endReconciliation', options) - command.request_representation = Google::Apis::ServicecontrolV1::EndReconciliationRequest::Representation - command.request_object = end_reconciliation_request_object - command.response_representation = Google::Apis::ServicecontrolV1::EndReconciliationResponse::Representation - command.response_class = Google::Apis::ServicecontrolV1::EndReconciliationResponse - command.params['serviceName'] = service_name unless service_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 - - # Releases previously allocated quota done through AllocateQuota method. - # This method requires the `servicemanagement.services.quota` - # permission on the specified service. For more information, see - # [Cloud IAM](https://cloud.google.com/iam). - # **NOTE:** The client **must** fail-open on server errors `INTERNAL`, - # `UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system - # reliability, the server may inject these errors to prohibit any hard - # dependency on the quota functionality. - # @param [String] service_name - # Name of the service as specified in the service configuration. For example, - # `"pubsub.googleapis.com"`. - # See google.api.Service for the definition of a service name. - # @param [Google::Apis::ServicecontrolV1::ReleaseQuotaRequest] release_quota_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::ServicecontrolV1::ReleaseQuotaResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ServicecontrolV1::ReleaseQuotaResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def release_service_quota(service_name, release_quota_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1/services/{serviceName}:releaseQuota', options) - command.request_representation = Google::Apis::ServicecontrolV1::ReleaseQuotaRequest::Representation - command.request_object = release_quota_request_object - command.response_representation = Google::Apis::ServicecontrolV1::ReleaseQuotaResponse::Representation - command.response_class = Google::Apis::ServicecontrolV1::ReleaseQuotaResponse - command.params['serviceName'] = service_name unless service_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 - # Reports operation results to Google Service Control, such as logs and # metrics. It should be called after an operation is completed. # If feasible, the client should aggregate reporting data for up to 5 @@ -269,63 +188,6 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end - - # Unlike rate quota, allocation quota does not get refilled periodically. - # So, it is possible that the quota usage as seen by the service differs from - # what the One Platform considers the usage is. This is expected to happen - # only rarely, but over time this can accumulate. Services can invoke - # StartReconciliation and EndReconciliation to correct this usage drift, as - # described below: - # 1. Service sends StartReconciliation with a timestamp in future for each - # metric that needs to be reconciled. The timestamp being in future allows - # to account for in-flight AllocateQuota and ReleaseQuota requests for the - # same metric. - # 2. One Platform records this timestamp and starts tracking subsequent - # AllocateQuota and ReleaseQuota requests until EndReconciliation is - # called. - # 3. At or after the time specified in the StartReconciliation, service - # sends EndReconciliation with the usage that needs to be reconciled to. - # 4. One Platform adjusts its own record of usage for that metric to the - # value specified in EndReconciliation by taking in to account any - # allocation or release between StartReconciliation and EndReconciliation. - # Signals the quota controller that the service wants to perform a usage - # reconciliation as specified in the request. - # This method requires the `servicemanagement.services.quota` - # permission on the specified service. For more information, see - # [Google Cloud IAM](https://cloud.google.com/iam). - # @param [String] service_name - # Name of the service as specified in the service configuration. For example, - # `"pubsub.googleapis.com"`. - # See google.api.Service for the definition of a service name. - # @param [Google::Apis::ServicecontrolV1::StartReconciliationRequest] start_reconciliation_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::ServicecontrolV1::StartReconciliationResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::ServicecontrolV1::StartReconciliationResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def start_service_reconciliation(service_name, start_reconciliation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1/services/{serviceName}:startReconciliation', options) - command.request_representation = Google::Apis::ServicecontrolV1::StartReconciliationRequest::Representation - command.request_object = start_reconciliation_request_object - command.response_representation = Google::Apis::ServicecontrolV1::StartReconciliationResponse::Representation - command.response_class = Google::Apis::ServicecontrolV1::StartReconciliationResponse - command.params['serviceName'] = service_name unless service_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 diff --git a/generated/google/apis/servicenetworking_v1beta.rb b/generated/google/apis/servicenetworking_v1beta.rb index 576cda00e..dd4d395ce 100644 --- a/generated/google/apis/servicenetworking_v1beta.rb +++ b/generated/google/apis/servicenetworking_v1beta.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started module ServicenetworkingV1beta VERSION = 'V1beta' - REVISION = '20181004' + REVISION = '20181030' # 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/servicenetworking_v1beta/classes.rb b/generated/google/apis/servicenetworking_v1beta/classes.rb index 0cf48a102..2e968cdc0 100644 --- a/generated/google/apis/servicenetworking_v1beta/classes.rb +++ b/generated/google/apis/servicenetworking_v1beta/classes.rb @@ -65,6 +65,15 @@ module Google # @return [String] attr_accessor :region + # Optional. The starting address of a range. The address must be a valid + # IPv4 address in the x.x.x.x format. This value combined with the IP prefix + # range is the CIDR range for the subnet. The range must be within the + # allocated range that is assigned to the private connection. If the CIDR + # range isn't available, the call fails. + # Corresponds to the JSON property `requestedAddress` + # @return [String] + attr_accessor :requested_address + # Required. Name for the new subnetwork. # Must be a legal [subnetwork](compute/docs/reference/rest/v1/subnetworks) # name. @@ -89,6 +98,7 @@ module Google @description = args[:description] if args.key?(:description) @ip_prefix_length = args[:ip_prefix_length] if args.key?(:ip_prefix_length) @region = args[:region] if args.key?(:region) + @requested_address = args[:requested_address] if args.key?(:requested_address) @subnetwork = args[:subnetwork] if args.key?(:subnetwork) @subnetwork_users = args[:subnetwork_users] if args.key?(:subnetwork_users) end @@ -453,6 +463,12 @@ module Google # @return [Float] attr_accessor :min_deadline + # The number of seconds to wait for the completion of a long running + # operation. The default is no deadline. + # Corresponds to the JSON property `operationDeadline` + # @return [Float] + attr_accessor :operation_deadline + # Selects the methods to which this rule applies. # Refer to selector for syntax details. # Corresponds to the JSON property `selector` @@ -468,6 +484,7 @@ module Google @address = args[:address] if args.key?(:address) @deadline = args[:deadline] if args.key?(:deadline) @min_deadline = args[:min_deadline] if args.key?(:min_deadline) + @operation_deadline = args[:operation_deadline] if args.key?(:operation_deadline) @selector = args[:selector] if args.key?(:selector) end end @@ -3168,6 +3185,12 @@ module Google # @return [String] attr_accessor :name + # Shared VPC host project network peered with consumer network. + # For example: projects/1234321/global/networks/host-network + # Corresponds to the JSON property `network` + # @return [String] + attr_accessor :network + def initialize(**args) update!(**args) end @@ -3176,6 +3199,7 @@ module Google def update!(**args) @ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range) @name = args[:name] if args.key?(:name) + @network = args[:network] if args.key?(:network) end end diff --git a/generated/google/apis/servicenetworking_v1beta/representations.rb b/generated/google/apis/servicenetworking_v1beta/representations.rb index e52140dad..7f52a4c93 100644 --- a/generated/google/apis/servicenetworking_v1beta/representations.rb +++ b/generated/google/apis/servicenetworking_v1beta/representations.rb @@ -372,6 +372,7 @@ module Google property :description, as: 'description' property :ip_prefix_length, as: 'ipPrefixLength' property :region, as: 'region' + property :requested_address, as: 'requestedAddress' property :subnetwork, as: 'subnetwork' collection :subnetwork_users, as: 'subnetworkUsers' end @@ -456,6 +457,7 @@ module Google property :address, as: 'address' property :deadline, as: 'deadline' property :min_deadline, as: 'minDeadline' + property :operation_deadline, as: 'operationDeadline' property :selector, as: 'selector' end end @@ -925,6 +927,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :ip_cidr_range, as: 'ipCidrRange' property :name, as: 'name' + property :network, as: 'network' end end diff --git a/generated/google/apis/serviceusage_v1.rb b/generated/google/apis/serviceusage_v1.rb index 1adec552c..8535c864c 100644 --- a/generated/google/apis/serviceusage_v1.rb +++ b/generated/google/apis/serviceusage_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-usage/ module ServiceusageV1 VERSION = 'V1' - REVISION = '20181004' + REVISION = '20181030' # 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/serviceusage_v1/classes.rb b/generated/google/apis/serviceusage_v1/classes.rb index d44542a55..6bee98c66 100644 --- a/generated/google/apis/serviceusage_v1/classes.rb +++ b/generated/google/apis/serviceusage_v1/classes.rb @@ -381,6 +381,12 @@ module Google # @return [Float] attr_accessor :min_deadline + # The number of seconds to wait for the completion of a long running + # operation. The default is no deadline. + # Corresponds to the JSON property `operationDeadline` + # @return [Float] + attr_accessor :operation_deadline + # Selects the methods to which this rule applies. # Refer to selector for syntax details. # Corresponds to the JSON property `selector` @@ -396,6 +402,7 @@ module Google @address = args[:address] if args.key?(:address) @deadline = args[:deadline] if args.key?(:deadline) @min_deadline = args[:min_deadline] if args.key?(:min_deadline) + @operation_deadline = args[:operation_deadline] if args.key?(:operation_deadline) @selector = args[:selector] if args.key?(:selector) end end diff --git a/generated/google/apis/serviceusage_v1/representations.rb b/generated/google/apis/serviceusage_v1/representations.rb index 6449ae508..dfff0930f 100644 --- a/generated/google/apis/serviceusage_v1/representations.rb +++ b/generated/google/apis/serviceusage_v1/representations.rb @@ -509,6 +509,7 @@ module Google property :address, as: 'address' property :deadline, as: 'deadline' property :min_deadline, as: 'minDeadline' + property :operation_deadline, as: 'operationDeadline' property :selector, as: 'selector' end end diff --git a/generated/google/apis/serviceusage_v1beta1.rb b/generated/google/apis/serviceusage_v1beta1.rb index a034a76c5..82e197c88 100644 --- a/generated/google/apis/serviceusage_v1beta1.rb +++ b/generated/google/apis/serviceusage_v1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-usage/ module ServiceusageV1beta1 VERSION = 'V1beta1' - REVISION = '20181004' + REVISION = '20181030' # 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/serviceusage_v1beta1/classes.rb b/generated/google/apis/serviceusage_v1beta1/classes.rb index 943cc0196..bfb770bed 100644 --- a/generated/google/apis/serviceusage_v1beta1/classes.rb +++ b/generated/google/apis/serviceusage_v1beta1/classes.rb @@ -381,6 +381,12 @@ module Google # @return [Float] attr_accessor :min_deadline + # The number of seconds to wait for the completion of a long running + # operation. The default is no deadline. + # Corresponds to the JSON property `operationDeadline` + # @return [Float] + attr_accessor :operation_deadline + # Selects the methods to which this rule applies. # Refer to selector for syntax details. # Corresponds to the JSON property `selector` @@ -396,6 +402,7 @@ module Google @address = args[:address] if args.key?(:address) @deadline = args[:deadline] if args.key?(:deadline) @min_deadline = args[:min_deadline] if args.key?(:min_deadline) + @operation_deadline = args[:operation_deadline] if args.key?(:operation_deadline) @selector = args[:selector] if args.key?(:selector) end end diff --git a/generated/google/apis/serviceusage_v1beta1/representations.rb b/generated/google/apis/serviceusage_v1beta1/representations.rb index b00b75c04..a4f78e941 100644 --- a/generated/google/apis/serviceusage_v1beta1/representations.rb +++ b/generated/google/apis/serviceusage_v1beta1/representations.rb @@ -515,6 +515,7 @@ module Google property :address, as: 'address' property :deadline, as: 'deadline' property :min_deadline, as: 'minDeadline' + property :operation_deadline, as: 'operationDeadline' property :selector, as: 'selector' end end diff --git a/generated/google/apis/slides_v1.rb b/generated/google/apis/slides_v1.rb index 6e1d970ea..b17f62c71 100644 --- a/generated/google/apis/slides_v1.rb +++ b/generated/google/apis/slides_v1.rb @@ -20,12 +20,12 @@ module Google module Apis # Google Slides API # - # An API for creating and editing Google Slides presentations. + # Reads and writes Google Slides presentations. # # @see https://developers.google.com/slides/ module SlidesV1 VERSION = 'V1' - REVISION = '20181010' + REVISION = '20181030' # 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/service.rb b/generated/google/apis/slides_v1/service.rb index c1443ae6d..ff8c3f6dc 100644 --- a/generated/google/apis/slides_v1/service.rb +++ b/generated/google/apis/slides_v1/service.rb @@ -22,7 +22,7 @@ module Google module SlidesV1 # Google Slides API # - # An API for creating and editing Google Slides presentations. + # Reads and writes Google Slides presentations. # # @example # require 'google/apis/slides_v1' diff --git a/generated/google/apis/storage_v1.rb b/generated/google/apis/storage_v1.rb index 9557c3e75..103ad49d2 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 = '20180905' + REVISION = '20181013' # 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 696065bef..857443e1d 100644 --- a/generated/google/apis/storage_v1/service.rb +++ b/generated/google/apis/storage_v1/service.rb @@ -554,9 +554,8 @@ module Google execute_or_queue_command(command, &block) end - # Updates a bucket. Changes to the bucket will be readable immediately after - # writing, but configuration changes may take time to propagate. This method - # supports patch semantics. + # Patches a bucket. Changes to the bucket will be readable immediately after + # writing, but configuration changes may take time to propagate. # @param [String] bucket # Name of a bucket. # @param [Google::Apis::StorageV1::Bucket] bucket_object diff --git a/generated/google/apis/testing_v1.rb b/generated/google/apis/testing_v1.rb index ff6a3f175..9418bcc7d 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 = '20181003' + REVISION = '20181025' # 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 96c62e19e..a138fa70c 100644 --- a/generated/google/apis/testing_v1/classes.rb +++ b/generated/google/apis/testing_v1/classes.rb @@ -313,6 +313,14 @@ module Google # @return [String] attr_accessor :id + # True if and only if tests with this model are recorded by stitching + # together screenshots. See use_low_spec_video_recording in device config. + # @OutputOnly + # Corresponds to the JSON property `lowFpsVideoRecording` + # @return [Boolean] + attr_accessor :low_fps_video_recording + alias_method :low_fps_video_recording?, :low_fps_video_recording + # The manufacturer of this device. # @OutputOnly # Corresponds to the JSON property `manufacturer` @@ -388,6 +396,7 @@ module Google @form = args[:form] if args.key?(:form) @form_factor = args[:form_factor] if args.key?(:form_factor) @id = args[:id] if args.key?(:id) + @low_fps_video_recording = args[:low_fps_video_recording] if args.key?(:low_fps_video_recording) @manufacturer = args[:manufacturer] if args.key?(:manufacturer) @name = args[:name] if args.key?(:name) @screen_density = args[:screen_density] if args.key?(:screen_density) diff --git a/generated/google/apis/testing_v1/representations.rb b/generated/google/apis/testing_v1/representations.rb index eb01652f7..e4ba0e1b1 100644 --- a/generated/google/apis/testing_v1/representations.rb +++ b/generated/google/apis/testing_v1/representations.rb @@ -447,6 +447,7 @@ module Google property :form, as: 'form' property :form_factor, as: 'formFactor' property :id, as: 'id' + property :low_fps_video_recording, as: 'lowFpsVideoRecording' property :manufacturer, as: 'manufacturer' property :name, as: 'name' property :screen_density, as: 'screenDensity' diff --git a/generated/google/apis/videointelligence_v1.rb b/generated/google/apis/videointelligence_v1.rb index 6582bf8f2..bb9ad4be1 100644 --- a/generated/google/apis/videointelligence_v1.rb +++ b/generated/google/apis/videointelligence_v1.rb @@ -20,12 +20,13 @@ module Google module Apis # Cloud Video Intelligence API # - # Cloud Video Intelligence API. + # Detects objects, explicit content, and scene changes in videos. It also + # specifies the region for annotation and transcribes speech to text. # # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1 VERSION = 'V1' - REVISION = '20181003' + REVISION = '20181027' # 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_v1/classes.rb b/generated/google/apis/videointelligence_v1/classes.rb index c8de09446..36eb0a138 100644 --- a/generated/google/apis/videointelligence_v1/classes.rb +++ b/generated/google/apis/videointelligence_v1/classes.rb @@ -383,6 +383,197 @@ module Google end end + # Provides "hints" to the speech recognizer to favor specific words and phrases + # in the results. + class GoogleCloudVideointelligenceV1SpeechContext + include Google::Apis::Core::Hashable + + # *Optional* A list of strings containing words and phrases "hints" so that + # the speech recognition is more likely to recognize them. This can be used + # to improve the accuracy for specific words and phrases, for example, if + # specific commands are typically spoken by the user. This can also be used + # to add additional words to the vocabulary of the recognizer. See + # [usage limits](https://cloud.google.com/speech/limits#content). + # Corresponds to the JSON property `phrases` + # @return [Array] + attr_accessor :phrases + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @phrases = args[:phrases] if args.key?(:phrases) + end + end + + # Alternative hypotheses (a.k.a. n-best list). + class GoogleCloudVideointelligenceV1SpeechRecognitionAlternative + include Google::Apis::Core::Hashable + + # The confidence estimate between 0.0 and 1.0. A higher number + # 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. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Transcript text representing the words that the user spoke. + # Corresponds to the JSON property `transcript` + # @return [String] + attr_accessor :transcript + + # A list of word-specific information for each recognized word. + # 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) + @confidence = args[:confidence] if args.key?(:confidence) + @transcript = args[:transcript] if args.key?(:transcript) + @words = args[:words] if args.key?(:words) + end + end + + # A speech recognition result corresponding to a portion of the audio. + class GoogleCloudVideointelligenceV1SpeechTranscription + include Google::Apis::Core::Hashable + + # May contain one or more recognition hypotheses (up to the maximum specified + # in `max_alternatives`). These alternatives are ordered in terms of + # accuracy, with the top (first) alternative being the most probable, as + # ranked by the recognizer. + # Corresponds to the JSON property `alternatives` + # @return [Array] + attr_accessor :alternatives + + # Output only. The + # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the + # language in this result. This language code was detected to have the most + # likelihood of being spoken in the audio. + # 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) + @alternatives = args[:alternatives] if args.key?(:alternatives) + @language_code = args[:language_code] if args.key?(:language_code) + end + end + + # Config for SPEECH_TRANSCRIPTION. + class GoogleCloudVideointelligenceV1SpeechTranscriptionConfig + include Google::Apis::Core::Hashable + + # *Optional* For file formats, such as MXF or MKV, supporting multiple audio + # tracks, specify up to two tracks. Default: track 0. + # Corresponds to the JSON property `audioTracks` + # @return [Array] + attr_accessor :audio_tracks + + # *Optional* + # If set, specifies the estimated number of speakers in the conversation. + # If not set, defaults to '2'. + # Ignored unless enable_speaker_diarization is set to true. + # Corresponds to the JSON property `diarizationSpeakerCount` + # @return [Fixnum] + attr_accessor :diarization_speaker_count + + # *Optional* If 'true', adds punctuation to recognition result hypotheses. + # This feature is only available in select languages. Setting this for + # requests in other languages has no effect at all. The default 'false' value + # does not add punctuation to result hypotheses. NOTE: "This is currently + # offered as an experimental service, complimentary to all users. In the + # future this may be exclusively available as a premium feature." + # Corresponds to the JSON property `enableAutomaticPunctuation` + # @return [Boolean] + attr_accessor :enable_automatic_punctuation + alias_method :enable_automatic_punctuation?, :enable_automatic_punctuation + + # *Optional* If 'true', enables speaker detection for each recognized word in + # the top alternative of the recognition result using a speaker_tag provided + # in the WordInfo. + # Note: When this is true, we send all the words from the beginning of the + # audio for the top alternative in every consecutive responses. + # This is done in order to improve our speaker tags as our models learn to + # identify the speakers in the conversation over time. + # Corresponds to the JSON property `enableSpeakerDiarization` + # @return [Boolean] + attr_accessor :enable_speaker_diarization + alias_method :enable_speaker_diarization?, :enable_speaker_diarization + + # *Optional* If `true`, the top result includes a list of words and the + # confidence for those words. If `false`, no word-level confidence + # information is returned. The default is `false`. + # Corresponds to the JSON property `enableWordConfidence` + # @return [Boolean] + attr_accessor :enable_word_confidence + alias_method :enable_word_confidence?, :enable_word_confidence + + # *Optional* If set to `true`, the server will attempt to filter out + # profanities, replacing all but the initial character in each filtered word + # with asterisks, e.g. "f***". If set to `false` or omitted, profanities + # won't be filtered out. + # Corresponds to the JSON property `filterProfanity` + # @return [Boolean] + attr_accessor :filter_profanity + alias_method :filter_profanity?, :filter_profanity + + # *Required* The language of the supplied audio as a + # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + # Example: "en-US". + # See [Language Support](https://cloud.google.com/speech/docs/languages) + # for a list of the currently supported language codes. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # *Optional* Maximum number of recognition hypotheses to be returned. + # Specifically, the maximum number of `SpeechRecognitionAlternative` messages + # within each `SpeechTranscription`. The server may return fewer than + # `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will + # return a maximum of one. If omitted, will return a maximum of one. + # Corresponds to the JSON property `maxAlternatives` + # @return [Fixnum] + attr_accessor :max_alternatives + + # *Optional* A means to provide context to assist the speech recognition. + # Corresponds to the JSON property `speechContexts` + # @return [Array] + attr_accessor :speech_contexts + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audio_tracks = args[:audio_tracks] if args.key?(:audio_tracks) + @diarization_speaker_count = args[:diarization_speaker_count] if args.key?(:diarization_speaker_count) + @enable_automatic_punctuation = args[:enable_automatic_punctuation] if args.key?(:enable_automatic_punctuation) + @enable_speaker_diarization = args[:enable_speaker_diarization] if args.key?(:enable_speaker_diarization) + @enable_word_confidence = args[:enable_word_confidence] if args.key?(:enable_word_confidence) + @filter_profanity = args[:filter_profanity] if args.key?(:filter_profanity) + @language_code = args[:language_code] if args.key?(:language_code) + @max_alternatives = args[:max_alternatives] if args.key?(:max_alternatives) + @speech_contexts = args[:speech_contexts] if args.key?(:speech_contexts) + end + end + # Annotation progress for a single video. class GoogleCloudVideointelligenceV1VideoAnnotationProgress include Google::Apis::Core::Hashable @@ -505,6 +696,11 @@ module Google # @return [Array] attr_accessor :shot_label_annotations + # Speech transcription. + # Corresponds to the JSON property `speechTranscriptions` + # @return [Array] + attr_accessor :speech_transcriptions + def initialize(**args) update!(**args) end @@ -518,6 +714,7 @@ module Google @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) + @speech_transcriptions = args[:speech_transcriptions] if args.key?(:speech_transcriptions) end end @@ -547,6 +744,11 @@ module Google # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1ShotChangeDetectionConfig] attr_accessor :shot_change_detection_config + # Config for SPEECH_TRANSCRIPTION. + # Corresponds to the JSON property `speechTranscriptionConfig` + # @return [Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1SpeechTranscriptionConfig] + attr_accessor :speech_transcription_config + def initialize(**args) update!(**args) end @@ -557,6 +759,7 @@ module Google @label_detection_config = args[:label_detection_config] if args.key?(:label_detection_config) @segments = args[:segments] if args.key?(:segments) @shot_change_detection_config = args[:shot_change_detection_config] if args.key?(:shot_change_detection_config) + @speech_transcription_config = args[:speech_transcription_config] if args.key?(:speech_transcription_config) end end @@ -587,6 +790,65 @@ module Google end end + # Word-specific information for recognized words. Word information is only + # included in the response when certain request parameters are set, such + # as `enable_word_time_offsets`. + class GoogleCloudVideointelligenceV1WordInfo + include Google::Apis::Core::Hashable + + # Output only. The confidence estimate between 0.0 and 1.0. A higher number + # indicates an estimated greater likelihood that the recognized words are + # correct. This field is set only for the top alternative. + # This field is not guaranteed to be accurate and users should not rely on it + # to be always provided. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Time offset relative to the beginning of the audio, and + # corresponding to the end of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Output only. A distinct integer value is assigned for every speaker within + # the audio. This field specifies which one of those speakers was detected to + # have spoken this word. Value ranges from 1 up to diarization_speaker_count, + # and is only set if speaker diarization is enabled. + # Corresponds to the JSON property `speakerTag` + # @return [Fixnum] + attr_accessor :speaker_tag + + # Time offset relative to the beginning of the audio, and + # corresponding to the start of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # The word corresponding to this set of information. + # Corresponds to the JSON property `word` + # @return [String] + attr_accessor :word + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @confidence = args[:confidence] if args.key?(:confidence) + @end_time = args[:end_time] if args.key?(:end_time) + @speaker_tag = args[:speaker_tag] if args.key?(:speaker_tag) + @start_time = args[:start_time] if args.key?(:start_time) + @word = args[:word] if args.key?(:word) + end + end + # Video annotation progress. Included in the `metadata` # field of the `Operation` returned by the `GetOperation` # call of the `google::longrunning::Operations` service. @@ -800,6 +1062,73 @@ module Google end end + # Alternative hypotheses (a.k.a. n-best list). + class GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative + include Google::Apis::Core::Hashable + + # The confidence estimate between 0.0 and 1.0. A higher number + # 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. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Transcript text representing the words that the user spoke. + # Corresponds to the JSON property `transcript` + # @return [String] + attr_accessor :transcript + + # A list of word-specific information for each recognized word. + # 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) + @confidence = args[:confidence] if args.key?(:confidence) + @transcript = args[:transcript] if args.key?(:transcript) + @words = args[:words] if args.key?(:words) + end + end + + # A speech recognition result corresponding to a portion of the audio. + class GoogleCloudVideointelligenceV1beta2SpeechTranscription + include Google::Apis::Core::Hashable + + # May contain one or more recognition hypotheses (up to the maximum specified + # in `max_alternatives`). These alternatives are ordered in terms of + # accuracy, with the top (first) alternative being the most probable, as + # ranked by the recognizer. + # Corresponds to the JSON property `alternatives` + # @return [Array] + attr_accessor :alternatives + + # Output only. The + # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the + # language in this result. This language code was detected to have the most + # likelihood of being spoken in the audio. + # 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) + @alternatives = args[:alternatives] if args.key?(:alternatives) + @language_code = args[:language_code] if args.key?(:language_code) + end + end + # Annotation progress for a single video. class GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress include Google::Apis::Core::Hashable @@ -922,6 +1251,11 @@ module Google # @return [Array] attr_accessor :shot_label_annotations + # Speech transcription. + # Corresponds to the JSON property `speechTranscriptions` + # @return [Array] + attr_accessor :speech_transcriptions + def initialize(**args) update!(**args) end @@ -935,6 +1269,7 @@ module Google @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) + @speech_transcriptions = args[:speech_transcriptions] if args.key?(:speech_transcriptions) end end @@ -965,6 +1300,65 @@ module Google end end + # Word-specific information for recognized words. Word information is only + # included in the response when certain request parameters are set, such + # as `enable_word_time_offsets`. + class GoogleCloudVideointelligenceV1beta2WordInfo + include Google::Apis::Core::Hashable + + # Output only. The confidence estimate between 0.0 and 1.0. A higher number + # indicates an estimated greater likelihood that the recognized words are + # correct. This field is set only for the top alternative. + # This field is not guaranteed to be accurate and users should not rely on it + # to be always provided. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Time offset relative to the beginning of the audio, and + # corresponding to the end of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Output only. A distinct integer value is assigned for every speaker within + # the audio. This field specifies which one of those speakers was detected to + # have spoken this word. Value ranges from 1 up to diarization_speaker_count, + # and is only set if speaker diarization is enabled. + # Corresponds to the JSON property `speakerTag` + # @return [Fixnum] + attr_accessor :speaker_tag + + # Time offset relative to the beginning of the audio, and + # corresponding to the start of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # The word corresponding to this set of information. + # Corresponds to the JSON property `word` + # @return [String] + attr_accessor :word + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @confidence = args[:confidence] if args.key?(:confidence) + @end_time = args[:end_time] if args.key?(:end_time) + @speaker_tag = args[:speaker_tag] if args.key?(:speaker_tag) + @start_time = args[:start_time] if args.key?(:start_time) + @word = args[:word] if args.key?(:word) + end + end + # Video annotation progress. Included in the `metadata` # field of the `Operation` returned by the `GetOperation` # call of the `google::longrunning::Operations` service. @@ -1852,6 +2246,73 @@ module Google end end + # Alternative hypotheses (a.k.a. n-best list). + class GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative + include Google::Apis::Core::Hashable + + # The confidence estimate between 0.0 and 1.0. A higher number + # 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. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Transcript text representing the words that the user spoke. + # Corresponds to the JSON property `transcript` + # @return [String] + attr_accessor :transcript + + # A list of word-specific information for each recognized word. + # 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) + @confidence = args[:confidence] if args.key?(:confidence) + @transcript = args[:transcript] if args.key?(:transcript) + @words = args[:words] if args.key?(:words) + end + end + + # A speech recognition result corresponding to a portion of the audio. + class GoogleCloudVideointelligenceV1p2beta1SpeechTranscription + include Google::Apis::Core::Hashable + + # May contain one or more recognition hypotheses (up to the maximum specified + # in `max_alternatives`). These alternatives are ordered in terms of + # accuracy, with the top (first) alternative being the most probable, as + # ranked by the recognizer. + # Corresponds to the JSON property `alternatives` + # @return [Array] + attr_accessor :alternatives + + # Output only. The + # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the + # language in this result. This language code was detected to have the most + # likelihood of being spoken in the audio. + # 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) + @alternatives = args[:alternatives] if args.key?(:alternatives) + @language_code = args[:language_code] if args.key?(:language_code) + end + end + # Annotations related to one detected OCR text snippet. This will contain the # corresponding text, confidence value, and frame level information for each # detection. @@ -2079,6 +2540,11 @@ module Google # @return [Array] attr_accessor :shot_label_annotations + # Speech transcription. + # Corresponds to the JSON property `speechTranscriptions` + # @return [Array] + attr_accessor :speech_transcriptions + # OCR text detection and tracking. # Annotations for list of detected text snippets. Each will have list of # frame information associated with it. @@ -2100,6 +2566,7 @@ module Google @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) + @speech_transcriptions = args[:speech_transcriptions] if args.key?(:speech_transcriptions) @text_annotations = args[:text_annotations] if args.key?(:text_annotations) end end @@ -2131,6 +2598,65 @@ module Google end end + # Word-specific information for recognized words. Word information is only + # included in the response when certain request parameters are set, such + # as `enable_word_time_offsets`. + class GoogleCloudVideointelligenceV1p2beta1WordInfo + include Google::Apis::Core::Hashable + + # Output only. The confidence estimate between 0.0 and 1.0. A higher number + # indicates an estimated greater likelihood that the recognized words are + # correct. This field is set only for the top alternative. + # This field is not guaranteed to be accurate and users should not rely on it + # to be always provided. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Time offset relative to the beginning of the audio, and + # corresponding to the end of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Output only. A distinct integer value is assigned for every speaker within + # the audio. This field specifies which one of those speakers was detected to + # have spoken this word. Value ranges from 1 up to diarization_speaker_count, + # and is only set if speaker diarization is enabled. + # Corresponds to the JSON property `speakerTag` + # @return [Fixnum] + attr_accessor :speaker_tag + + # Time offset relative to the beginning of the audio, and + # corresponding to the start of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # The word corresponding to this set of information. + # Corresponds to the JSON property `word` + # @return [String] + attr_accessor :word + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @confidence = args[:confidence] if args.key?(:confidence) + @end_time = args[:end_time] if args.key?(:end_time) + @speaker_tag = args[:speaker_tag] if args.key?(:speaker_tag) + @start_time = args[:start_time] if args.key?(:start_time) + @word = args[:word] if args.key?(:word) + end + end + # The request message for Operations.CancelOperation. class GoogleLongrunningCancelOperationRequest include Google::Apis::Core::Hashable diff --git a/generated/google/apis/videointelligence_v1/representations.rb b/generated/google/apis/videointelligence_v1/representations.rb index 5a4484a50..d1125d207 100644 --- a/generated/google/apis/videointelligence_v1/representations.rb +++ b/generated/google/apis/videointelligence_v1/representations.rb @@ -94,6 +94,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1SpeechContext + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1SpeechRecognitionAlternative + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1SpeechTranscription + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1SpeechTranscriptionConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1VideoAnnotationProgress class Representation < Google::Apis::Core::JsonRepresentation; end @@ -118,6 +142,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1WordInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1beta2AnnotateVideoProgress class Representation < Google::Apis::Core::JsonRepresentation; end @@ -166,6 +196,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1beta2SpeechTranscription + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress class Representation < Google::Apis::Core::JsonRepresentation; end @@ -184,6 +226,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1beta2WordInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1p1beta1AnnotateVideoProgress class Representation < Google::Apis::Core::JsonRepresentation; end @@ -346,6 +394,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1p2beta1SpeechTranscription + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1p2beta1TextAnnotation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -382,6 +442,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1p2beta1WordInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleLongrunningCancelOperationRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -520,6 +586,48 @@ module Google end end + class GoogleCloudVideointelligenceV1SpeechContext + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :phrases, as: 'phrases' + end + end + + class GoogleCloudVideointelligenceV1SpeechRecognitionAlternative + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :transcript, as: 'transcript' + collection :words, as: 'words', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1WordInfo, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1WordInfo::Representation + + end + end + + class GoogleCloudVideointelligenceV1SpeechTranscription + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :alternatives, as: 'alternatives', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1SpeechRecognitionAlternative, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1SpeechRecognitionAlternative::Representation + + property :language_code, as: 'languageCode' + end + end + + class GoogleCloudVideointelligenceV1SpeechTranscriptionConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audio_tracks, as: 'audioTracks' + property :diarization_speaker_count, as: 'diarizationSpeakerCount' + property :enable_automatic_punctuation, as: 'enableAutomaticPunctuation' + property :enable_speaker_diarization, as: 'enableSpeakerDiarization' + property :enable_word_confidence, as: 'enableWordConfidence' + property :filter_profanity, as: 'filterProfanity' + property :language_code, as: 'languageCode' + property :max_alternatives, as: 'maxAlternatives' + collection :speech_contexts, as: 'speechContexts', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1SpeechContext, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1SpeechContext::Representation + + end + end + class GoogleCloudVideointelligenceV1VideoAnnotationProgress # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -546,6 +654,8 @@ module Google collection :shot_label_annotations, as: 'shotLabelAnnotations', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1LabelAnnotation, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1LabelAnnotation::Representation + collection :speech_transcriptions, as: 'speechTranscriptions', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1SpeechTranscription, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1SpeechTranscription::Representation + end end @@ -560,6 +670,8 @@ module Google property :shot_change_detection_config, as: 'shotChangeDetectionConfig', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1ShotChangeDetectionConfig, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1ShotChangeDetectionConfig::Representation + property :speech_transcription_config, as: 'speechTranscriptionConfig', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1SpeechTranscriptionConfig, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1SpeechTranscriptionConfig::Representation + end end @@ -571,6 +683,17 @@ module Google end end + class GoogleCloudVideointelligenceV1WordInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :end_time, as: 'endTime' + property :speaker_tag, as: 'speakerTag' + property :start_time, as: 'startTime' + property :word, as: 'word' + end + end + class GoogleCloudVideointelligenceV1beta2AnnotateVideoProgress # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -643,6 +766,25 @@ module Google end end + class GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :transcript, as: 'transcript' + collection :words, as: 'words', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2WordInfo, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2WordInfo::Representation + + end + end + + class GoogleCloudVideointelligenceV1beta2SpeechTranscription + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :alternatives, as: 'alternatives', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative::Representation + + property :language_code, as: 'languageCode' + end + end + class GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -669,6 +811,8 @@ module Google collection :shot_label_annotations, as: 'shotLabelAnnotations', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2LabelAnnotation, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2LabelAnnotation::Representation + collection :speech_transcriptions, as: 'speechTranscriptions', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2SpeechTranscription, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1beta2SpeechTranscription::Representation + end end @@ -680,6 +824,17 @@ module Google end end + class GoogleCloudVideointelligenceV1beta2WordInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :end_time, as: 'endTime' + property :speaker_tag, as: 'speakerTag' + property :start_time, as: 'startTime' + property :word, as: 'word' + end + end + class GoogleCloudVideointelligenceV1p1beta1AnnotateVideoProgress # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -941,6 +1096,25 @@ module Google end end + class GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :transcript, as: 'transcript' + collection :words, as: 'words', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1WordInfo, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1WordInfo::Representation + + end + end + + class GoogleCloudVideointelligenceV1p2beta1SpeechTranscription + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :alternatives, as: 'alternatives', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative::Representation + + property :language_code, as: 'languageCode' + end + end + class GoogleCloudVideointelligenceV1p2beta1TextAnnotation # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -998,6 +1172,8 @@ module Google collection :shot_label_annotations, as: 'shotLabelAnnotations', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1LabelAnnotation, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1LabelAnnotation::Representation + collection :speech_transcriptions, as: 'speechTranscriptions', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1SpeechTranscription, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1SpeechTranscription::Representation + collection :text_annotations, as: 'textAnnotations', class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1TextAnnotation, decorator: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1p2beta1TextAnnotation::Representation end @@ -1011,6 +1187,17 @@ module Google end end + class GoogleCloudVideointelligenceV1p2beta1WordInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :end_time, as: 'endTime' + property :speaker_tag, as: 'speakerTag' + property :start_time, as: 'startTime' + property :word, as: 'word' + end + end + class GoogleLongrunningCancelOperationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/videointelligence_v1/service.rb b/generated/google/apis/videointelligence_v1/service.rb index 480f4c7a9..9818d8710 100644 --- a/generated/google/apis/videointelligence_v1/service.rb +++ b/generated/google/apis/videointelligence_v1/service.rb @@ -22,7 +22,8 @@ module Google module VideointelligenceV1 # Cloud Video Intelligence API # - # Cloud Video Intelligence API. + # Detects objects, explicit content, and scene changes in videos. It also + # specifies the region for annotation and transcribes speech to text. # # @example # require 'google/apis/videointelligence_v1' diff --git a/generated/google/apis/videointelligence_v1beta2.rb b/generated/google/apis/videointelligence_v1beta2.rb index da785d87a..014e436de 100644 --- a/generated/google/apis/videointelligence_v1beta2.rb +++ b/generated/google/apis/videointelligence_v1beta2.rb @@ -20,12 +20,13 @@ module Google module Apis # Cloud Video Intelligence API # - # Cloud Video Intelligence API. + # Detects objects, explicit content, and scene changes in videos. It also + # specifies the region for annotation and transcribes speech to text. # # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1beta2 VERSION = 'V1beta2' - REVISION = '20181003' + REVISION = '20181027' # 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_v1beta2/classes.rb b/generated/google/apis/videointelligence_v1beta2/classes.rb index 99e474812..392aaac45 100644 --- a/generated/google/apis/videointelligence_v1beta2/classes.rb +++ b/generated/google/apis/videointelligence_v1beta2/classes.rb @@ -235,6 +235,73 @@ module Google end end + # Alternative hypotheses (a.k.a. n-best list). + class GoogleCloudVideointelligenceV1SpeechRecognitionAlternative + include Google::Apis::Core::Hashable + + # The confidence estimate between 0.0 and 1.0. A higher number + # 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. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Transcript text representing the words that the user spoke. + # Corresponds to the JSON property `transcript` + # @return [String] + attr_accessor :transcript + + # A list of word-specific information for each recognized word. + # 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) + @confidence = args[:confidence] if args.key?(:confidence) + @transcript = args[:transcript] if args.key?(:transcript) + @words = args[:words] if args.key?(:words) + end + end + + # A speech recognition result corresponding to a portion of the audio. + class GoogleCloudVideointelligenceV1SpeechTranscription + include Google::Apis::Core::Hashable + + # May contain one or more recognition hypotheses (up to the maximum specified + # in `max_alternatives`). These alternatives are ordered in terms of + # accuracy, with the top (first) alternative being the most probable, as + # ranked by the recognizer. + # Corresponds to the JSON property `alternatives` + # @return [Array] + attr_accessor :alternatives + + # Output only. The + # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the + # language in this result. This language code was detected to have the most + # likelihood of being spoken in the audio. + # 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) + @alternatives = args[:alternatives] if args.key?(:alternatives) + @language_code = args[:language_code] if args.key?(:language_code) + end + end + # Annotation progress for a single video. class GoogleCloudVideointelligenceV1VideoAnnotationProgress include Google::Apis::Core::Hashable @@ -357,6 +424,11 @@ module Google # @return [Array] attr_accessor :shot_label_annotations + # Speech transcription. + # Corresponds to the JSON property `speechTranscriptions` + # @return [Array] + attr_accessor :speech_transcriptions + def initialize(**args) update!(**args) end @@ -370,6 +442,7 @@ module Google @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) + @speech_transcriptions = args[:speech_transcriptions] if args.key?(:speech_transcriptions) end end @@ -400,6 +473,65 @@ module Google end end + # Word-specific information for recognized words. Word information is only + # included in the response when certain request parameters are set, such + # as `enable_word_time_offsets`. + class GoogleCloudVideointelligenceV1WordInfo + include Google::Apis::Core::Hashable + + # Output only. The confidence estimate between 0.0 and 1.0. A higher number + # indicates an estimated greater likelihood that the recognized words are + # correct. This field is set only for the top alternative. + # This field is not guaranteed to be accurate and users should not rely on it + # to be always provided. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Time offset relative to the beginning of the audio, and + # corresponding to the end of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Output only. A distinct integer value is assigned for every speaker within + # the audio. This field specifies which one of those speakers was detected to + # have spoken this word. Value ranges from 1 up to diarization_speaker_count, + # and is only set if speaker diarization is enabled. + # Corresponds to the JSON property `speakerTag` + # @return [Fixnum] + attr_accessor :speaker_tag + + # Time offset relative to the beginning of the audio, and + # corresponding to the start of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # The word corresponding to this set of information. + # Corresponds to the JSON property `word` + # @return [String] + attr_accessor :word + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @confidence = args[:confidence] if args.key?(:confidence) + @end_time = args[:end_time] if args.key?(:end_time) + @speaker_tag = args[:speaker_tag] if args.key?(:speaker_tag) + @start_time = args[:start_time] if args.key?(:start_time) + @word = args[:word] if args.key?(:word) + end + end + # Video annotation progress. Included in the `metadata` # field of the `Operation` returned by the `GetOperation` # call of the `google::longrunning::Operations` service. @@ -761,6 +893,197 @@ module Google end end + # Provides "hints" to the speech recognizer to favor specific words and phrases + # in the results. + class GoogleCloudVideointelligenceV1beta2SpeechContext + include Google::Apis::Core::Hashable + + # *Optional* A list of strings containing words and phrases "hints" so that + # the speech recognition is more likely to recognize them. This can be used + # to improve the accuracy for specific words and phrases, for example, if + # specific commands are typically spoken by the user. This can also be used + # to add additional words to the vocabulary of the recognizer. See + # [usage limits](https://cloud.google.com/speech/limits#content). + # Corresponds to the JSON property `phrases` + # @return [Array] + attr_accessor :phrases + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @phrases = args[:phrases] if args.key?(:phrases) + end + end + + # Alternative hypotheses (a.k.a. n-best list). + class GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative + include Google::Apis::Core::Hashable + + # The confidence estimate between 0.0 and 1.0. A higher number + # 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. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Transcript text representing the words that the user spoke. + # Corresponds to the JSON property `transcript` + # @return [String] + attr_accessor :transcript + + # A list of word-specific information for each recognized word. + # 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) + @confidence = args[:confidence] if args.key?(:confidence) + @transcript = args[:transcript] if args.key?(:transcript) + @words = args[:words] if args.key?(:words) + end + end + + # A speech recognition result corresponding to a portion of the audio. + class GoogleCloudVideointelligenceV1beta2SpeechTranscription + include Google::Apis::Core::Hashable + + # May contain one or more recognition hypotheses (up to the maximum specified + # in `max_alternatives`). These alternatives are ordered in terms of + # accuracy, with the top (first) alternative being the most probable, as + # ranked by the recognizer. + # Corresponds to the JSON property `alternatives` + # @return [Array] + attr_accessor :alternatives + + # Output only. The + # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the + # language in this result. This language code was detected to have the most + # likelihood of being spoken in the audio. + # 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) + @alternatives = args[:alternatives] if args.key?(:alternatives) + @language_code = args[:language_code] if args.key?(:language_code) + end + end + + # Config for SPEECH_TRANSCRIPTION. + class GoogleCloudVideointelligenceV1beta2SpeechTranscriptionConfig + include Google::Apis::Core::Hashable + + # *Optional* For file formats, such as MXF or MKV, supporting multiple audio + # tracks, specify up to two tracks. Default: track 0. + # Corresponds to the JSON property `audioTracks` + # @return [Array] + attr_accessor :audio_tracks + + # *Optional* + # If set, specifies the estimated number of speakers in the conversation. + # If not set, defaults to '2'. + # Ignored unless enable_speaker_diarization is set to true. + # Corresponds to the JSON property `diarizationSpeakerCount` + # @return [Fixnum] + attr_accessor :diarization_speaker_count + + # *Optional* If 'true', adds punctuation to recognition result hypotheses. + # This feature is only available in select languages. Setting this for + # requests in other languages has no effect at all. The default 'false' value + # does not add punctuation to result hypotheses. NOTE: "This is currently + # offered as an experimental service, complimentary to all users. In the + # future this may be exclusively available as a premium feature." + # Corresponds to the JSON property `enableAutomaticPunctuation` + # @return [Boolean] + attr_accessor :enable_automatic_punctuation + alias_method :enable_automatic_punctuation?, :enable_automatic_punctuation + + # *Optional* If 'true', enables speaker detection for each recognized word in + # the top alternative of the recognition result using a speaker_tag provided + # in the WordInfo. + # Note: When this is true, we send all the words from the beginning of the + # audio for the top alternative in every consecutive responses. + # This is done in order to improve our speaker tags as our models learn to + # identify the speakers in the conversation over time. + # Corresponds to the JSON property `enableSpeakerDiarization` + # @return [Boolean] + attr_accessor :enable_speaker_diarization + alias_method :enable_speaker_diarization?, :enable_speaker_diarization + + # *Optional* If `true`, the top result includes a list of words and the + # confidence for those words. If `false`, no word-level confidence + # information is returned. The default is `false`. + # Corresponds to the JSON property `enableWordConfidence` + # @return [Boolean] + attr_accessor :enable_word_confidence + alias_method :enable_word_confidence?, :enable_word_confidence + + # *Optional* If set to `true`, the server will attempt to filter out + # profanities, replacing all but the initial character in each filtered word + # with asterisks, e.g. "f***". If set to `false` or omitted, profanities + # won't be filtered out. + # Corresponds to the JSON property `filterProfanity` + # @return [Boolean] + attr_accessor :filter_profanity + alias_method :filter_profanity?, :filter_profanity + + # *Required* The language of the supplied audio as a + # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + # Example: "en-US". + # See [Language Support](https://cloud.google.com/speech/docs/languages) + # for a list of the currently supported language codes. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # *Optional* Maximum number of recognition hypotheses to be returned. + # Specifically, the maximum number of `SpeechRecognitionAlternative` messages + # within each `SpeechTranscription`. The server may return fewer than + # `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` will + # return a maximum of one. If omitted, will return a maximum of one. + # Corresponds to the JSON property `maxAlternatives` + # @return [Fixnum] + attr_accessor :max_alternatives + + # *Optional* A means to provide context to assist the speech recognition. + # Corresponds to the JSON property `speechContexts` + # @return [Array] + attr_accessor :speech_contexts + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audio_tracks = args[:audio_tracks] if args.key?(:audio_tracks) + @diarization_speaker_count = args[:diarization_speaker_count] if args.key?(:diarization_speaker_count) + @enable_automatic_punctuation = args[:enable_automatic_punctuation] if args.key?(:enable_automatic_punctuation) + @enable_speaker_diarization = args[:enable_speaker_diarization] if args.key?(:enable_speaker_diarization) + @enable_word_confidence = args[:enable_word_confidence] if args.key?(:enable_word_confidence) + @filter_profanity = args[:filter_profanity] if args.key?(:filter_profanity) + @language_code = args[:language_code] if args.key?(:language_code) + @max_alternatives = args[:max_alternatives] if args.key?(:max_alternatives) + @speech_contexts = args[:speech_contexts] if args.key?(:speech_contexts) + end + end + # Annotation progress for a single video. class GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress include Google::Apis::Core::Hashable @@ -883,6 +1206,11 @@ module Google # @return [Array] attr_accessor :shot_label_annotations + # Speech transcription. + # Corresponds to the JSON property `speechTranscriptions` + # @return [Array] + attr_accessor :speech_transcriptions + def initialize(**args) update!(**args) end @@ -896,6 +1224,7 @@ module Google @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) + @speech_transcriptions = args[:speech_transcriptions] if args.key?(:speech_transcriptions) end end @@ -925,6 +1254,11 @@ module Google # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2ShotChangeDetectionConfig] attr_accessor :shot_change_detection_config + # Config for SPEECH_TRANSCRIPTION. + # Corresponds to the JSON property `speechTranscriptionConfig` + # @return [Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2SpeechTranscriptionConfig] + attr_accessor :speech_transcription_config + def initialize(**args) update!(**args) end @@ -935,6 +1269,7 @@ module Google @label_detection_config = args[:label_detection_config] if args.key?(:label_detection_config) @segments = args[:segments] if args.key?(:segments) @shot_change_detection_config = args[:shot_change_detection_config] if args.key?(:shot_change_detection_config) + @speech_transcription_config = args[:speech_transcription_config] if args.key?(:speech_transcription_config) end end @@ -965,6 +1300,65 @@ module Google end end + # Word-specific information for recognized words. Word information is only + # included in the response when certain request parameters are set, such + # as `enable_word_time_offsets`. + class GoogleCloudVideointelligenceV1beta2WordInfo + include Google::Apis::Core::Hashable + + # Output only. The confidence estimate between 0.0 and 1.0. A higher number + # indicates an estimated greater likelihood that the recognized words are + # correct. This field is set only for the top alternative. + # This field is not guaranteed to be accurate and users should not rely on it + # to be always provided. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Time offset relative to the beginning of the audio, and + # corresponding to the end of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Output only. A distinct integer value is assigned for every speaker within + # the audio. This field specifies which one of those speakers was detected to + # have spoken this word. Value ranges from 1 up to diarization_speaker_count, + # and is only set if speaker diarization is enabled. + # Corresponds to the JSON property `speakerTag` + # @return [Fixnum] + attr_accessor :speaker_tag + + # Time offset relative to the beginning of the audio, and + # corresponding to the start of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # The word corresponding to this set of information. + # Corresponds to the JSON property `word` + # @return [String] + attr_accessor :word + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @confidence = args[:confidence] if args.key?(:confidence) + @end_time = args[:end_time] if args.key?(:end_time) + @speaker_tag = args[:speaker_tag] if args.key?(:speaker_tag) + @start_time = args[:start_time] if args.key?(:start_time) + @word = args[:word] if args.key?(:word) + end + end + # Video annotation progress. Included in the `metadata` # field of the `Operation` returned by the `GetOperation` # call of the `google::longrunning::Operations` service. @@ -1852,6 +2246,73 @@ module Google end end + # Alternative hypotheses (a.k.a. n-best list). + class GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative + include Google::Apis::Core::Hashable + + # The confidence estimate between 0.0 and 1.0. A higher number + # 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. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Transcript text representing the words that the user spoke. + # Corresponds to the JSON property `transcript` + # @return [String] + attr_accessor :transcript + + # A list of word-specific information for each recognized word. + # 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) + @confidence = args[:confidence] if args.key?(:confidence) + @transcript = args[:transcript] if args.key?(:transcript) + @words = args[:words] if args.key?(:words) + end + end + + # A speech recognition result corresponding to a portion of the audio. + class GoogleCloudVideointelligenceV1p2beta1SpeechTranscription + include Google::Apis::Core::Hashable + + # May contain one or more recognition hypotheses (up to the maximum specified + # in `max_alternatives`). These alternatives are ordered in terms of + # accuracy, with the top (first) alternative being the most probable, as + # ranked by the recognizer. + # Corresponds to the JSON property `alternatives` + # @return [Array] + attr_accessor :alternatives + + # Output only. The + # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the + # language in this result. This language code was detected to have the most + # likelihood of being spoken in the audio. + # 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) + @alternatives = args[:alternatives] if args.key?(:alternatives) + @language_code = args[:language_code] if args.key?(:language_code) + end + end + # Annotations related to one detected OCR text snippet. This will contain the # corresponding text, confidence value, and frame level information for each # detection. @@ -2079,6 +2540,11 @@ module Google # @return [Array] attr_accessor :shot_label_annotations + # Speech transcription. + # Corresponds to the JSON property `speechTranscriptions` + # @return [Array] + attr_accessor :speech_transcriptions + # OCR text detection and tracking. # Annotations for list of detected text snippets. Each will have list of # frame information associated with it. @@ -2100,6 +2566,7 @@ module Google @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) + @speech_transcriptions = args[:speech_transcriptions] if args.key?(:speech_transcriptions) @text_annotations = args[:text_annotations] if args.key?(:text_annotations) end end @@ -2131,6 +2598,65 @@ module Google end end + # Word-specific information for recognized words. Word information is only + # included in the response when certain request parameters are set, such + # as `enable_word_time_offsets`. + class GoogleCloudVideointelligenceV1p2beta1WordInfo + include Google::Apis::Core::Hashable + + # Output only. The confidence estimate between 0.0 and 1.0. A higher number + # indicates an estimated greater likelihood that the recognized words are + # correct. This field is set only for the top alternative. + # This field is not guaranteed to be accurate and users should not rely on it + # to be always provided. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Time offset relative to the beginning of the audio, and + # corresponding to the end of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Output only. A distinct integer value is assigned for every speaker within + # the audio. This field specifies which one of those speakers was detected to + # have spoken this word. Value ranges from 1 up to diarization_speaker_count, + # and is only set if speaker diarization is enabled. + # Corresponds to the JSON property `speakerTag` + # @return [Fixnum] + attr_accessor :speaker_tag + + # Time offset relative to the beginning of the audio, and + # corresponding to the start of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # The word corresponding to this set of information. + # Corresponds to the JSON property `word` + # @return [String] + attr_accessor :word + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @confidence = args[:confidence] if args.key?(:confidence) + @end_time = args[:end_time] if args.key?(:end_time) + @speaker_tag = args[:speaker_tag] if args.key?(:speaker_tag) + @start_time = args[:start_time] if args.key?(:start_time) + @word = args[:word] if args.key?(:word) + end + end + # This resource represents a long-running operation that is the result of a # network API call. class GoogleLongrunningOperation diff --git a/generated/google/apis/videointelligence_v1beta2/representations.rb b/generated/google/apis/videointelligence_v1beta2/representations.rb index 12af92c84..f6b7ca783 100644 --- a/generated/google/apis/videointelligence_v1beta2/representations.rb +++ b/generated/google/apis/videointelligence_v1beta2/representations.rb @@ -70,6 +70,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1SpeechRecognitionAlternative + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1SpeechTranscription + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1VideoAnnotationProgress class Representation < Google::Apis::Core::JsonRepresentation; end @@ -88,6 +100,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1WordInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1beta2AnnotateVideoProgress class Representation < Google::Apis::Core::JsonRepresentation; end @@ -160,6 +178,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1beta2SpeechContext + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1beta2SpeechTranscription + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1beta2SpeechTranscriptionConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress class Representation < Google::Apis::Core::JsonRepresentation; end @@ -184,6 +226,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1beta2WordInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1p1beta1AnnotateVideoProgress class Representation < Google::Apis::Core::JsonRepresentation; end @@ -346,6 +394,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1p2beta1SpeechTranscription + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1p2beta1TextAnnotation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -382,6 +442,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1p2beta1WordInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleLongrunningOperation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -466,6 +532,25 @@ module Google end end + class GoogleCloudVideointelligenceV1SpeechRecognitionAlternative + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :transcript, as: 'transcript' + collection :words, as: 'words', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1WordInfo, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1WordInfo::Representation + + end + end + + class GoogleCloudVideointelligenceV1SpeechTranscription + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :alternatives, as: 'alternatives', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1SpeechRecognitionAlternative, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1SpeechRecognitionAlternative::Representation + + property :language_code, as: 'languageCode' + end + end + class GoogleCloudVideointelligenceV1VideoAnnotationProgress # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -492,6 +577,8 @@ module Google collection :shot_label_annotations, as: 'shotLabelAnnotations', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1LabelAnnotation, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1LabelAnnotation::Representation + collection :speech_transcriptions, as: 'speechTranscriptions', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1SpeechTranscription, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1SpeechTranscription::Representation + end end @@ -503,6 +590,17 @@ module Google end end + class GoogleCloudVideointelligenceV1WordInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :end_time, as: 'endTime' + property :speaker_tag, as: 'speakerTag' + property :start_time, as: 'startTime' + property :word, as: 'word' + end + end + class GoogleCloudVideointelligenceV1beta2AnnotateVideoProgress # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -611,6 +709,48 @@ module Google end end + class GoogleCloudVideointelligenceV1beta2SpeechContext + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :phrases, as: 'phrases' + end + end + + class GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :transcript, as: 'transcript' + collection :words, as: 'words', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2WordInfo, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2WordInfo::Representation + + end + end + + class GoogleCloudVideointelligenceV1beta2SpeechTranscription + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :alternatives, as: 'alternatives', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative::Representation + + property :language_code, as: 'languageCode' + end + end + + class GoogleCloudVideointelligenceV1beta2SpeechTranscriptionConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :audio_tracks, as: 'audioTracks' + property :diarization_speaker_count, as: 'diarizationSpeakerCount' + property :enable_automatic_punctuation, as: 'enableAutomaticPunctuation' + property :enable_speaker_diarization, as: 'enableSpeakerDiarization' + property :enable_word_confidence, as: 'enableWordConfidence' + property :filter_profanity, as: 'filterProfanity' + property :language_code, as: 'languageCode' + property :max_alternatives, as: 'maxAlternatives' + collection :speech_contexts, as: 'speechContexts', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2SpeechContext, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2SpeechContext::Representation + + end + end + class GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -637,6 +777,8 @@ module Google collection :shot_label_annotations, as: 'shotLabelAnnotations', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2LabelAnnotation, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2LabelAnnotation::Representation + collection :speech_transcriptions, as: 'speechTranscriptions', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2SpeechTranscription, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2SpeechTranscription::Representation + end end @@ -651,6 +793,8 @@ module Google property :shot_change_detection_config, as: 'shotChangeDetectionConfig', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2ShotChangeDetectionConfig, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2ShotChangeDetectionConfig::Representation + property :speech_transcription_config, as: 'speechTranscriptionConfig', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2SpeechTranscriptionConfig, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1beta2SpeechTranscriptionConfig::Representation + end end @@ -662,6 +806,17 @@ module Google end end + class GoogleCloudVideointelligenceV1beta2WordInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :end_time, as: 'endTime' + property :speaker_tag, as: 'speakerTag' + property :start_time, as: 'startTime' + property :word, as: 'word' + end + end + class GoogleCloudVideointelligenceV1p1beta1AnnotateVideoProgress # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -923,6 +1078,25 @@ module Google end end + class GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :transcript, as: 'transcript' + collection :words, as: 'words', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1WordInfo, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1WordInfo::Representation + + end + end + + class GoogleCloudVideointelligenceV1p2beta1SpeechTranscription + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :alternatives, as: 'alternatives', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative::Representation + + property :language_code, as: 'languageCode' + end + end + class GoogleCloudVideointelligenceV1p2beta1TextAnnotation # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -980,6 +1154,8 @@ module Google collection :shot_label_annotations, as: 'shotLabelAnnotations', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1LabelAnnotation, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1LabelAnnotation::Representation + collection :speech_transcriptions, as: 'speechTranscriptions', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1SpeechTranscription, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1SpeechTranscription::Representation + collection :text_annotations, as: 'textAnnotations', class: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1TextAnnotation, decorator: Google::Apis::VideointelligenceV1beta2::GoogleCloudVideointelligenceV1p2beta1TextAnnotation::Representation end @@ -993,6 +1169,17 @@ module Google end end + class GoogleCloudVideointelligenceV1p2beta1WordInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :end_time, as: 'endTime' + property :speaker_tag, as: 'speakerTag' + property :start_time, as: 'startTime' + property :word, as: 'word' + end + end + class GoogleLongrunningOperation # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/videointelligence_v1beta2/service.rb b/generated/google/apis/videointelligence_v1beta2/service.rb index 641629609..3801435fa 100644 --- a/generated/google/apis/videointelligence_v1beta2/service.rb +++ b/generated/google/apis/videointelligence_v1beta2/service.rb @@ -22,7 +22,8 @@ module Google module VideointelligenceV1beta2 # Cloud Video Intelligence API # - # Cloud Video Intelligence API. + # Detects objects, explicit content, and scene changes in videos. It also + # specifies the region for annotation and transcribes speech to text. # # @example # require 'google/apis/videointelligence_v1beta2' diff --git a/generated/google/apis/videointelligence_v1p1beta1.rb b/generated/google/apis/videointelligence_v1p1beta1.rb index d740f4dfe..1dd7a8280 100644 --- a/generated/google/apis/videointelligence_v1p1beta1.rb +++ b/generated/google/apis/videointelligence_v1p1beta1.rb @@ -20,12 +20,13 @@ module Google module Apis # Cloud Video Intelligence API # - # Cloud Video Intelligence API. + # Detects objects, explicit content, and scene changes in videos. It also + # specifies the region for annotation and transcribes speech to text. # # @see https://cloud.google.com/video-intelligence/docs/ module VideointelligenceV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20181003' + REVISION = '20181027' # 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_v1p1beta1/classes.rb b/generated/google/apis/videointelligence_v1p1beta1/classes.rb index 0f0c86850..5758efb78 100644 --- a/generated/google/apis/videointelligence_v1p1beta1/classes.rb +++ b/generated/google/apis/videointelligence_v1p1beta1/classes.rb @@ -235,6 +235,73 @@ module Google end end + # Alternative hypotheses (a.k.a. n-best list). + class GoogleCloudVideointelligenceV1SpeechRecognitionAlternative + include Google::Apis::Core::Hashable + + # The confidence estimate between 0.0 and 1.0. A higher number + # 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. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Transcript text representing the words that the user spoke. + # Corresponds to the JSON property `transcript` + # @return [String] + attr_accessor :transcript + + # A list of word-specific information for each recognized word. + # 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) + @confidence = args[:confidence] if args.key?(:confidence) + @transcript = args[:transcript] if args.key?(:transcript) + @words = args[:words] if args.key?(:words) + end + end + + # A speech recognition result corresponding to a portion of the audio. + class GoogleCloudVideointelligenceV1SpeechTranscription + include Google::Apis::Core::Hashable + + # May contain one or more recognition hypotheses (up to the maximum specified + # in `max_alternatives`). These alternatives are ordered in terms of + # accuracy, with the top (first) alternative being the most probable, as + # ranked by the recognizer. + # Corresponds to the JSON property `alternatives` + # @return [Array] + attr_accessor :alternatives + + # Output only. The + # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the + # language in this result. This language code was detected to have the most + # likelihood of being spoken in the audio. + # 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) + @alternatives = args[:alternatives] if args.key?(:alternatives) + @language_code = args[:language_code] if args.key?(:language_code) + end + end + # Annotation progress for a single video. class GoogleCloudVideointelligenceV1VideoAnnotationProgress include Google::Apis::Core::Hashable @@ -357,6 +424,11 @@ module Google # @return [Array] attr_accessor :shot_label_annotations + # Speech transcription. + # Corresponds to the JSON property `speechTranscriptions` + # @return [Array] + attr_accessor :speech_transcriptions + def initialize(**args) update!(**args) end @@ -370,6 +442,7 @@ module Google @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) + @speech_transcriptions = args[:speech_transcriptions] if args.key?(:speech_transcriptions) end end @@ -400,6 +473,65 @@ module Google end end + # Word-specific information for recognized words. Word information is only + # included in the response when certain request parameters are set, such + # as `enable_word_time_offsets`. + class GoogleCloudVideointelligenceV1WordInfo + include Google::Apis::Core::Hashable + + # Output only. The confidence estimate between 0.0 and 1.0. A higher number + # indicates an estimated greater likelihood that the recognized words are + # correct. This field is set only for the top alternative. + # This field is not guaranteed to be accurate and users should not rely on it + # to be always provided. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Time offset relative to the beginning of the audio, and + # corresponding to the end of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Output only. A distinct integer value is assigned for every speaker within + # the audio. This field specifies which one of those speakers was detected to + # have spoken this word. Value ranges from 1 up to diarization_speaker_count, + # and is only set if speaker diarization is enabled. + # Corresponds to the JSON property `speakerTag` + # @return [Fixnum] + attr_accessor :speaker_tag + + # Time offset relative to the beginning of the audio, and + # corresponding to the start of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # The word corresponding to this set of information. + # Corresponds to the JSON property `word` + # @return [String] + attr_accessor :word + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @confidence = args[:confidence] if args.key?(:confidence) + @end_time = args[:end_time] if args.key?(:end_time) + @speaker_tag = args[:speaker_tag] if args.key?(:speaker_tag) + @start_time = args[:start_time] if args.key?(:start_time) + @word = args[:word] if args.key?(:word) + end + end + # Video annotation progress. Included in the `metadata` # field of the `Operation` returned by the `GetOperation` # call of the `google::longrunning::Operations` service. @@ -613,6 +745,73 @@ module Google end end + # Alternative hypotheses (a.k.a. n-best list). + class GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative + include Google::Apis::Core::Hashable + + # The confidence estimate between 0.0 and 1.0. A higher number + # 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. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Transcript text representing the words that the user spoke. + # Corresponds to the JSON property `transcript` + # @return [String] + attr_accessor :transcript + + # A list of word-specific information for each recognized word. + # 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) + @confidence = args[:confidence] if args.key?(:confidence) + @transcript = args[:transcript] if args.key?(:transcript) + @words = args[:words] if args.key?(:words) + end + end + + # A speech recognition result corresponding to a portion of the audio. + class GoogleCloudVideointelligenceV1beta2SpeechTranscription + include Google::Apis::Core::Hashable + + # May contain one or more recognition hypotheses (up to the maximum specified + # in `max_alternatives`). These alternatives are ordered in terms of + # accuracy, with the top (first) alternative being the most probable, as + # ranked by the recognizer. + # Corresponds to the JSON property `alternatives` + # @return [Array] + attr_accessor :alternatives + + # Output only. The + # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the + # language in this result. This language code was detected to have the most + # likelihood of being spoken in the audio. + # 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) + @alternatives = args[:alternatives] if args.key?(:alternatives) + @language_code = args[:language_code] if args.key?(:language_code) + end + end + # Annotation progress for a single video. class GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress include Google::Apis::Core::Hashable @@ -735,6 +934,11 @@ module Google # @return [Array] attr_accessor :shot_label_annotations + # Speech transcription. + # Corresponds to the JSON property `speechTranscriptions` + # @return [Array] + attr_accessor :speech_transcriptions + def initialize(**args) update!(**args) end @@ -748,6 +952,7 @@ module Google @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) + @speech_transcriptions = args[:speech_transcriptions] if args.key?(:speech_transcriptions) end end @@ -778,6 +983,65 @@ module Google end end + # Word-specific information for recognized words. Word information is only + # included in the response when certain request parameters are set, such + # as `enable_word_time_offsets`. + class GoogleCloudVideointelligenceV1beta2WordInfo + include Google::Apis::Core::Hashable + + # Output only. The confidence estimate between 0.0 and 1.0. A higher number + # indicates an estimated greater likelihood that the recognized words are + # correct. This field is set only for the top alternative. + # This field is not guaranteed to be accurate and users should not rely on it + # to be always provided. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Time offset relative to the beginning of the audio, and + # corresponding to the end of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Output only. A distinct integer value is assigned for every speaker within + # the audio. This field specifies which one of those speakers was detected to + # have spoken this word. Value ranges from 1 up to diarization_speaker_count, + # and is only set if speaker diarization is enabled. + # Corresponds to the JSON property `speakerTag` + # @return [Fixnum] + attr_accessor :speaker_tag + + # Time offset relative to the beginning of the audio, and + # corresponding to the start of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # The word corresponding to this set of information. + # Corresponds to the JSON property `word` + # @return [String] + attr_accessor :word + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @confidence = args[:confidence] if args.key?(:confidence) + @end_time = args[:end_time] if args.key?(:end_time) + @speaker_tag = args[:speaker_tag] if args.key?(:speaker_tag) + @start_time = args[:start_time] if args.key?(:start_time) + @word = args[:word] if args.key?(:word) + end + end + # Video annotation progress. Included in the `metadata` # field of the `Operation` returned by the `GetOperation` # call of the `google::longrunning::Operations` service. @@ -1235,22 +1499,6 @@ module Google class GoogleCloudVideointelligenceV1p1beta1SpeechTranscriptionConfig include Google::Apis::Core::Hashable - # *Optional* A list of up to 3 additional - # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags, - # listing possible alternative languages of the supplied video. - # See [Language Support](/speech-to-text/docs/languages) - # for a list of the currently supported language codes. - # If alternative languages are listed, transcription result will contain - # transcription in the most likely language detected, including the main - # language_code. The transcription result will include the language tag - # of the language detected in the video. - # Note: This feature is only supported for Voice Command and Voice Search - # use cases and performance may vary for other use cases (e.g., phone call - # transcription). - # Corresponds to the JSON property `alternativeLanguageCodes` - # @return [Array] - attr_accessor :alternative_language_codes - # *Optional* For file formats, such as MXF or MKV, supporting multiple audio # tracks, specify up to two tracks. Default: track 0. # Corresponds to the JSON property `audioTracks` @@ -1334,7 +1582,6 @@ module Google # Update properties of this object def update!(**args) - @alternative_language_codes = args[:alternative_language_codes] if args.key?(:alternative_language_codes) @audio_tracks = args[:audio_tracks] if args.key?(:audio_tracks) @diarization_speaker_count = args[:diarization_speaker_count] if args.key?(:diarization_speaker_count) @enable_automatic_punctuation = args[:enable_automatic_punctuation] if args.key?(:enable_automatic_punctuation) @@ -1999,6 +2246,73 @@ module Google end end + # Alternative hypotheses (a.k.a. n-best list). + class GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative + include Google::Apis::Core::Hashable + + # The confidence estimate between 0.0 and 1.0. A higher number + # 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. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Transcript text representing the words that the user spoke. + # Corresponds to the JSON property `transcript` + # @return [String] + attr_accessor :transcript + + # A list of word-specific information for each recognized word. + # 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) + @confidence = args[:confidence] if args.key?(:confidence) + @transcript = args[:transcript] if args.key?(:transcript) + @words = args[:words] if args.key?(:words) + end + end + + # A speech recognition result corresponding to a portion of the audio. + class GoogleCloudVideointelligenceV1p2beta1SpeechTranscription + include Google::Apis::Core::Hashable + + # May contain one or more recognition hypotheses (up to the maximum specified + # in `max_alternatives`). These alternatives are ordered in terms of + # accuracy, with the top (first) alternative being the most probable, as + # ranked by the recognizer. + # Corresponds to the JSON property `alternatives` + # @return [Array] + attr_accessor :alternatives + + # Output only. The + # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag of the + # language in this result. This language code was detected to have the most + # likelihood of being spoken in the audio. + # 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) + @alternatives = args[:alternatives] if args.key?(:alternatives) + @language_code = args[:language_code] if args.key?(:language_code) + end + end + # Annotations related to one detected OCR text snippet. This will contain the # corresponding text, confidence value, and frame level information for each # detection. @@ -2226,6 +2540,11 @@ module Google # @return [Array] attr_accessor :shot_label_annotations + # Speech transcription. + # Corresponds to the JSON property `speechTranscriptions` + # @return [Array] + attr_accessor :speech_transcriptions + # OCR text detection and tracking. # Annotations for list of detected text snippets. Each will have list of # frame information associated with it. @@ -2247,6 +2566,7 @@ module Google @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) + @speech_transcriptions = args[:speech_transcriptions] if args.key?(:speech_transcriptions) @text_annotations = args[:text_annotations] if args.key?(:text_annotations) end end @@ -2278,6 +2598,65 @@ module Google end end + # Word-specific information for recognized words. Word information is only + # included in the response when certain request parameters are set, such + # as `enable_word_time_offsets`. + class GoogleCloudVideointelligenceV1p2beta1WordInfo + include Google::Apis::Core::Hashable + + # Output only. The confidence estimate between 0.0 and 1.0. A higher number + # indicates an estimated greater likelihood that the recognized words are + # correct. This field is set only for the top alternative. + # This field is not guaranteed to be accurate and users should not rely on it + # to be always provided. + # The default of 0.0 is a sentinel value indicating `confidence` was not set. + # Corresponds to the JSON property `confidence` + # @return [Float] + attr_accessor :confidence + + # Time offset relative to the beginning of the audio, and + # corresponding to the end of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # Output only. A distinct integer value is assigned for every speaker within + # the audio. This field specifies which one of those speakers was detected to + # have spoken this word. Value ranges from 1 up to diarization_speaker_count, + # and is only set if speaker diarization is enabled. + # Corresponds to the JSON property `speakerTag` + # @return [Fixnum] + attr_accessor :speaker_tag + + # Time offset relative to the beginning of the audio, and + # corresponding to the start of the spoken word. This field is only set if + # `enable_word_time_offsets=true` and only in the top hypothesis. This is an + # experimental feature and the accuracy of the time offset can vary. + # Corresponds to the JSON property `startTime` + # @return [String] + attr_accessor :start_time + + # The word corresponding to this set of information. + # Corresponds to the JSON property `word` + # @return [String] + attr_accessor :word + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @confidence = args[:confidence] if args.key?(:confidence) + @end_time = args[:end_time] if args.key?(:end_time) + @speaker_tag = args[:speaker_tag] if args.key?(:speaker_tag) + @start_time = args[:start_time] if args.key?(:start_time) + @word = args[:word] if args.key?(:word) + end + end + # This resource represents a long-running operation that is the result of a # network API call. class GoogleLongrunningOperation diff --git a/generated/google/apis/videointelligence_v1p1beta1/representations.rb b/generated/google/apis/videointelligence_v1p1beta1/representations.rb index 0ab261100..2f9f14420 100644 --- a/generated/google/apis/videointelligence_v1p1beta1/representations.rb +++ b/generated/google/apis/videointelligence_v1p1beta1/representations.rb @@ -70,6 +70,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1SpeechRecognitionAlternative + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1SpeechTranscription + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1VideoAnnotationProgress class Representation < Google::Apis::Core::JsonRepresentation; end @@ -88,6 +100,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1WordInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1beta2AnnotateVideoProgress class Representation < Google::Apis::Core::JsonRepresentation; end @@ -136,6 +154,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1beta2SpeechTranscription + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress class Representation < Google::Apis::Core::JsonRepresentation; end @@ -154,6 +184,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1beta2WordInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1p1beta1AnnotateVideoProgress class Representation < Google::Apis::Core::JsonRepresentation; end @@ -358,6 +394,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVideointelligenceV1p2beta1SpeechTranscription + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVideointelligenceV1p2beta1TextAnnotation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -394,6 +442,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVideointelligenceV1p2beta1WordInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleLongrunningOperation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -478,6 +532,25 @@ module Google end end + class GoogleCloudVideointelligenceV1SpeechRecognitionAlternative + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :transcript, as: 'transcript' + collection :words, as: 'words', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1WordInfo, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1WordInfo::Representation + + end + end + + class GoogleCloudVideointelligenceV1SpeechTranscription + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :alternatives, as: 'alternatives', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1SpeechRecognitionAlternative, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1SpeechRecognitionAlternative::Representation + + property :language_code, as: 'languageCode' + end + end + class GoogleCloudVideointelligenceV1VideoAnnotationProgress # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -504,6 +577,8 @@ module Google collection :shot_label_annotations, as: 'shotLabelAnnotations', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1LabelAnnotation, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1LabelAnnotation::Representation + collection :speech_transcriptions, as: 'speechTranscriptions', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1SpeechTranscription, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1SpeechTranscription::Representation + end end @@ -515,6 +590,17 @@ module Google end end + class GoogleCloudVideointelligenceV1WordInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :end_time, as: 'endTime' + property :speaker_tag, as: 'speakerTag' + property :start_time, as: 'startTime' + property :word, as: 'word' + end + end + class GoogleCloudVideointelligenceV1beta2AnnotateVideoProgress # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -587,6 +673,25 @@ module Google end end + class GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :transcript, as: 'transcript' + collection :words, as: 'words', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2WordInfo, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2WordInfo::Representation + + end + end + + class GoogleCloudVideointelligenceV1beta2SpeechTranscription + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :alternatives, as: 'alternatives', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2SpeechRecognitionAlternative::Representation + + property :language_code, as: 'languageCode' + end + end + class GoogleCloudVideointelligenceV1beta2VideoAnnotationProgress # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -613,6 +718,8 @@ module Google collection :shot_label_annotations, as: 'shotLabelAnnotations', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2LabelAnnotation, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2LabelAnnotation::Representation + collection :speech_transcriptions, as: 'speechTranscriptions', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2SpeechTranscription, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1beta2SpeechTranscription::Representation + end end @@ -624,6 +731,17 @@ module Google end end + class GoogleCloudVideointelligenceV1beta2WordInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :end_time, as: 'endTime' + property :speaker_tag, as: 'speakerTag' + property :start_time, as: 'startTime' + property :word, as: 'word' + end + end + class GoogleCloudVideointelligenceV1p1beta1AnnotateVideoProgress # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -761,7 +879,6 @@ module Google class GoogleCloudVideointelligenceV1p1beta1SpeechTranscriptionConfig # @private class Representation < Google::Apis::Core::JsonRepresentation - collection :alternative_language_codes, as: 'alternativeLanguageCodes' collection :audio_tracks, as: 'audioTracks' property :diarization_speaker_count, as: 'diarizationSpeakerCount' property :enable_automatic_punctuation, as: 'enableAutomaticPunctuation' @@ -961,6 +1078,25 @@ module Google end end + class GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :transcript, as: 'transcript' + collection :words, as: 'words', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1WordInfo, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1WordInfo::Representation + + end + end + + class GoogleCloudVideointelligenceV1p2beta1SpeechTranscription + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :alternatives, as: 'alternatives', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1SpeechRecognitionAlternative::Representation + + property :language_code, as: 'languageCode' + end + end + class GoogleCloudVideointelligenceV1p2beta1TextAnnotation # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1018,6 +1154,8 @@ module Google collection :shot_label_annotations, as: 'shotLabelAnnotations', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1LabelAnnotation, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1LabelAnnotation::Representation + collection :speech_transcriptions, as: 'speechTranscriptions', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1SpeechTranscription, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1SpeechTranscription::Representation + collection :text_annotations, as: 'textAnnotations', class: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1TextAnnotation, decorator: Google::Apis::VideointelligenceV1p1beta1::GoogleCloudVideointelligenceV1p2beta1TextAnnotation::Representation end @@ -1031,6 +1169,17 @@ module Google end end + class GoogleCloudVideointelligenceV1p2beta1WordInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :confidence, as: 'confidence' + property :end_time, as: 'endTime' + property :speaker_tag, as: 'speakerTag' + property :start_time, as: 'startTime' + property :word, as: 'word' + end + end + class GoogleLongrunningOperation # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/videointelligence_v1p1beta1/service.rb b/generated/google/apis/videointelligence_v1p1beta1/service.rb index 310a70b8b..f6107508d 100644 --- a/generated/google/apis/videointelligence_v1p1beta1/service.rb +++ b/generated/google/apis/videointelligence_v1p1beta1/service.rb @@ -22,7 +22,8 @@ module Google module VideointelligenceV1p1beta1 # Cloud Video Intelligence API # - # Cloud Video Intelligence API. + # Detects objects, explicit content, and scene changes in videos. It also + # specifies the region for annotation and transcribes speech to text. # # @example # require 'google/apis/videointelligence_v1p1beta1' diff --git a/generated/google/apis/vision_v1.rb b/generated/google/apis/vision_v1.rb index f3e0d3ae0..2eb874168 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 = '20180928' + REVISION = '20181031' # 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 7af9b6494..5a2bc3ecf 100644 --- a/generated/google/apis/vision_v1/classes.rb +++ b/generated/google/apis/vision_v1/classes.rb @@ -22,6 +22,27 @@ module Google module Apis module VisionV1 + # Request message for the `AddProductToProductSet` method. + class AddProductToProductSetRequest + include Google::Apis::Core::Hashable + + # The resource name for the Product to be added to this ProductSet. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + # Corresponds to the JSON property `product` + # @return [String] + attr_accessor :product + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @product = args[:product] if args.key?(:product) + end + end + # Response to a single file annotation request. A file may contain one or more # images, which individually have their own responses. class AnnotateFileResponse @@ -180,6 +201,11 @@ module Google # @return [Array] attr_accessor :logo_annotations + # Results for a product search request. + # Corresponds to the JSON property `productSearchResults` + # @return [Google::Apis::VisionV1::ProductSearchResults] + attr_accessor :product_search_results + # Set of features pertaining to the image, computed by computer vision # methods over safe-search verticals (for example, adult, spoof, medical, # violence). @@ -213,6 +239,7 @@ module Google @landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations) @localized_object_annotations = args[:localized_object_annotations] if args.key?(:localized_object_annotations) @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations) + @product_search_results = args[:product_search_results] if args.key?(:product_search_results) @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) @@ -353,6 +380,40 @@ module Google end end + # Metadata for the batch operations such as the current state. + # This is included in the `metadata` field of the `Operation` returned by the + # `GetOperation` call of the `google::longrunning::Operations` service. + class BatchOperationMetadata + include Google::Apis::Core::Hashable + + # The time when the batch request is finished and + # google.longrunning.Operation.done is set to true. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # The current state of the batch operation. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # The time when the batch request was submitted to the server. + # Corresponds to the JSON property `submitTime` + # @return [String] + attr_accessor :submit_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_time = args[:end_time] if args.key?(:end_time) + @state = args[:state] if args.key?(:state) + @submit_time = args[:submit_time] if args.key?(:submit_time) + end + end + # Logical element on the page. class Block include Google::Apis::Core::Hashable @@ -1277,6 +1338,11 @@ module Google # @return [Array] attr_accessor :logo_annotations + # Results for a product search request. + # Corresponds to the JSON property `productSearchResults` + # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ProductSearchResults] + attr_accessor :product_search_results + # Set of features pertaining to the image, computed by computer vision # methods over safe-search verticals (for example, adult, spoof, medical, # violence). @@ -1310,6 +1376,7 @@ module Google @landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations) @localized_object_annotations = args[:localized_object_annotations] if args.key?(:localized_object_annotations) @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations) + @product_search_results = args[:product_search_results] if args.key?(:product_search_results) @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) @@ -2205,6 +2272,183 @@ module Google end end + # A Product contains ReferenceImages. + class GoogleCloudVisionV1p1beta1Product + include Google::Apis::Core::Hashable + + # User-provided metadata to be stored with this product. Must be at most 4096 + # characters long. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The user-provided name for this Product. Must not be empty. Must be at most + # 4096 characters long. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The resource name of the product. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + # This field is ignored when creating a product. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The category for the product identified by the reference image. This should + # be either "homegoods", "apparel", or "toys". + # This field is immutable. + # Corresponds to the JSON property `productCategory` + # @return [String] + attr_accessor :product_category + + # Key-value pairs that can be attached to a product. At query time, + # constraints can be specified based on the product_labels. + # Note that integer values can be provided as strings, e.g. "1199". Only + # strings with integer values can match a range-based restriction which is + # to be supported soon. + # Multiple values can be assigned to the same key. One product may have up to + # 100 product_labels. + # Corresponds to the JSON property `productLabels` + # @return [Array] + attr_accessor :product_labels + + 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) + @name = args[:name] if args.key?(:name) + @product_category = args[:product_category] if args.key?(:product_category) + @product_labels = args[:product_labels] if args.key?(:product_labels) + end + end + + # A product label represented as a key-value pair. + class GoogleCloudVisionV1p1beta1ProductKeyValue + include Google::Apis::Core::Hashable + + # The key of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # The value of the label attached to the product. Cannot be empty and + # cannot exceed 128 bytes. + # 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 + + # Results for a product search request. + class GoogleCloudVisionV1p1beta1ProductSearchResults + include Google::Apis::Core::Hashable + + # Timestamp of the index which provided these results. Changes made after + # this time are not reflected in the current results. + # Corresponds to the JSON property `indexTime` + # @return [String] + attr_accessor :index_time + + # List of results grouped by products detected in the query image. Each entry + # corresponds to one bounding polygon in the query image, and contains the + # matching products specific to that region. There may be duplicate product + # matches in the union of all the per-product results. + # Corresponds to the JSON property `productGroupedResults` + # @return [Array] + attr_accessor :product_grouped_results + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @index_time = args[:index_time] if args.key?(:index_time) + @product_grouped_results = args[:product_grouped_results] if args.key?(:product_grouped_results) + @results = args[:results] if args.key?(:results) + end + end + + # Information about the products similar to a single product in a query + # image. + class GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1BoundingPoly] + attr_accessor :bounding_poly + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @results = args[:results] if args.key?(:results) + end + end + + # Information about a product. + class GoogleCloudVisionV1p1beta1ProductSearchResultsResult + include Google::Apis::Core::Hashable + + # The resource name of the image from the product that is the closest match + # to the query. + # Corresponds to the JSON property `image` + # @return [String] + attr_accessor :image + + # A Product contains ReferenceImages. + # Corresponds to the JSON property `product` + # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1Product] + attr_accessor :product + + # A confidence level on the match, ranging from 0 (no confidence) to + # 1 (full confidence). + # 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) + @image = args[:image] if args.key?(:image) + @product = args[:product] if args.key?(:product) + @score = args[:score] if args.key?(:score) + end + end + # A `Property` consists of a user-supplied name/value pair. class GoogleCloudVisionV1p1beta1Property include Google::Apis::Core::Hashable @@ -2808,6 +3052,11 @@ module Google # @return [Array] attr_accessor :logo_annotations + # Results for a product search request. + # Corresponds to the JSON property `productSearchResults` + # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1ProductSearchResults] + attr_accessor :product_search_results + # Set of features pertaining to the image, computed by computer vision # methods over safe-search verticals (for example, adult, spoof, medical, # violence). @@ -2841,6 +3090,7 @@ module Google @landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations) @localized_object_annotations = args[:localized_object_annotations] if args.key?(:localized_object_annotations) @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations) + @product_search_results = args[:product_search_results] if args.key?(:product_search_results) @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) @@ -3769,6 +4019,183 @@ module Google end end + # A Product contains ReferenceImages. + class GoogleCloudVisionV1p2beta1Product + include Google::Apis::Core::Hashable + + # User-provided metadata to be stored with this product. Must be at most 4096 + # characters long. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The user-provided name for this Product. Must not be empty. Must be at most + # 4096 characters long. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The resource name of the product. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + # This field is ignored when creating a product. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The category for the product identified by the reference image. This should + # be either "homegoods", "apparel", or "toys". + # This field is immutable. + # Corresponds to the JSON property `productCategory` + # @return [String] + attr_accessor :product_category + + # Key-value pairs that can be attached to a product. At query time, + # constraints can be specified based on the product_labels. + # Note that integer values can be provided as strings, e.g. "1199". Only + # strings with integer values can match a range-based restriction which is + # to be supported soon. + # Multiple values can be assigned to the same key. One product may have up to + # 100 product_labels. + # Corresponds to the JSON property `productLabels` + # @return [Array] + attr_accessor :product_labels + + 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) + @name = args[:name] if args.key?(:name) + @product_category = args[:product_category] if args.key?(:product_category) + @product_labels = args[:product_labels] if args.key?(:product_labels) + end + end + + # A product label represented as a key-value pair. + class GoogleCloudVisionV1p2beta1ProductKeyValue + include Google::Apis::Core::Hashable + + # The key of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # The value of the label attached to the product. Cannot be empty and + # cannot exceed 128 bytes. + # 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 + + # Results for a product search request. + class GoogleCloudVisionV1p2beta1ProductSearchResults + include Google::Apis::Core::Hashable + + # Timestamp of the index which provided these results. Changes made after + # this time are not reflected in the current results. + # Corresponds to the JSON property `indexTime` + # @return [String] + attr_accessor :index_time + + # List of results grouped by products detected in the query image. Each entry + # corresponds to one bounding polygon in the query image, and contains the + # matching products specific to that region. There may be duplicate product + # matches in the union of all the per-product results. + # Corresponds to the JSON property `productGroupedResults` + # @return [Array] + attr_accessor :product_grouped_results + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @index_time = args[:index_time] if args.key?(:index_time) + @product_grouped_results = args[:product_grouped_results] if args.key?(:product_grouped_results) + @results = args[:results] if args.key?(:results) + end + end + + # Information about the products similar to a single product in a query + # image. + class GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1BoundingPoly] + attr_accessor :bounding_poly + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @results = args[:results] if args.key?(:results) + end + end + + # Information about a product. + class GoogleCloudVisionV1p2beta1ProductSearchResultsResult + include Google::Apis::Core::Hashable + + # The resource name of the image from the product that is the closest match + # to the query. + # Corresponds to the JSON property `image` + # @return [String] + attr_accessor :image + + # A Product contains ReferenceImages. + # Corresponds to the JSON property `product` + # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1Product] + attr_accessor :product + + # A confidence level on the match, ranging from 0 (no confidence) to + # 1 (full confidence). + # 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) + @image = args[:image] if args.key?(:image) + @product = args[:product] if args.key?(:product) + @score = args[:score] if args.key?(:score) + end + end + # A `Property` consists of a user-supplied name/value pair. class GoogleCloudVisionV1p2beta1Property include Google::Apis::Core::Hashable @@ -5498,6 +5925,14 @@ module Google # @return [String] attr_accessor :index_time + # List of results grouped by products detected in the query image. Each entry + # corresponds to one bounding polygon in the query image, and contains the + # matching products specific to that region. There may be duplicate product + # matches in the union of all the per-product results. + # Corresponds to the JSON property `productGroupedResults` + # @return [Array] + attr_accessor :product_grouped_results + # List of results, one for each product match. # Corresponds to the JSON property `results` # @return [Array] @@ -5510,6 +5945,33 @@ module Google # Update properties of this object def update!(**args) @index_time = args[:index_time] if args.key?(:index_time) + @product_grouped_results = args[:product_grouped_results] if args.key?(:product_grouped_results) + @results = args[:results] if args.key?(:results) + end + end + + # Information about the products similar to a single product in a query + # image. + class GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1BoundingPoly] + attr_accessor :bounding_poly + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) @results = args[:results] if args.key?(:results) end end @@ -6068,6 +6530,32 @@ module Google end end + # Information about the products similar to a single product in a query + # image. + class GroupedResult + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1::BoundingPoly] + attr_accessor :bounding_poly + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @results = args[:results] if args.key?(:results) + end + end + # Client image to perform Google Cloud Vision API tasks over. class Image include Google::Apis::Core::Hashable @@ -6149,6 +6637,11 @@ module Google # @return [Google::Apis::VisionV1::LatLongRect] attr_accessor :lat_long_rect + # Parameters for a product search request. + # Corresponds to the JSON property `productSearchParams` + # @return [Google::Apis::VisionV1::ProductSearchParams] + attr_accessor :product_search_params + # Parameters for web detection request. # Corresponds to the JSON property `webDetectionParams` # @return [Google::Apis::VisionV1::WebDetectionParams] @@ -6163,6 +6656,7 @@ module Google @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) + @product_search_params = args[:product_search_params] if args.key?(:product_search_params) @web_detection_params = args[:web_detection_params] if args.key?(:web_detection_params) end end @@ -6228,6 +6722,143 @@ module Google end end + # The Google Cloud Storage location for a csv file which preserves a list of + # ImportProductSetRequests in each line. + class ImportProductSetsGcsSource + include Google::Apis::Core::Hashable + + # The Google Cloud Storage URI of the input csv file. + # The URI must start with `gs://`. + # The format of the input csv file should be one image per line. + # In each line, there are 8 columns. + # 1. image-uri + # 2. image-id + # 3. product-set-id + # 4. product-id + # 5. product-category + # 6. product-display-name + # 7. labels + # 8. bounding-poly + # The `image-uri`, `product-set-id`, `product-id`, and `product-category` + # columns are required. All other columns are optional. + # If the `ProductSet` or `Product` specified by the `product-set-id` and + # `product-id` values does not exist, then the system will create a new + # `ProductSet` or `Product` for the image. In this case, the + # `product-display-name` column refers to + # display_name, the + # `product-category` column refers to + # product_category, and the + # `labels` column refers to product_labels. + # The `image-id` column is optional but must be unique if provided. If it is + # empty, the system will automatically assign a unique id to the image. + # The `product-display-name` column is optional. If it is empty, the system + # sets the display_name field for the product to a + # space (" "). You can update the `display_name` later by using the API. + # If a `Product` with the specified `product-id` already exists, then the + # system ignores the `product-display-name`, `product-category`, and `labels` + # columns. + # The `labels` column (optional) is a line containing a list of + # comma-separated key-value pairs, in the following format: + # "key_1=value_1,key_2=value_2,...,key_n=value_n" + # The `bounding-poly` column (optional) identifies one region of + # interest from the image in the same manner as `CreateReferenceImage`. If + # you do not specify the `bounding-poly` column, then the system will try to + # detect regions of interest automatically. + # At most one `bounding-poly` column is allowed per line. If the image + # contains multiple regions of interest, add a line to the CSV file that + # includes the same product information, and the `bounding-poly` values for + # each region of interest. + # The `bounding-poly` column must contain an even number of comma-separated + # numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use + # non-negative integers for absolute bounding polygons, and float values + # in [0, 1] for normalized bounding polygons. + # The system will resize the image if the image resolution is too + # large to process (larger than 20MP). + # Corresponds to the JSON property `csvFileUri` + # @return [String] + attr_accessor :csv_file_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @csv_file_uri = args[:csv_file_uri] if args.key?(:csv_file_uri) + end + end + + # The input content for the `ImportProductSets` method. + class ImportProductSetsInputConfig + include Google::Apis::Core::Hashable + + # The Google Cloud Storage location for a csv file which preserves a list of + # ImportProductSetRequests in each line. + # Corresponds to the JSON property `gcsSource` + # @return [Google::Apis::VisionV1::ImportProductSetsGcsSource] + attr_accessor :gcs_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @gcs_source = args[:gcs_source] if args.key?(:gcs_source) + end + end + + # Request message for the `ImportProductSets` method. + class ImportProductSetsRequest + include Google::Apis::Core::Hashable + + # The input content for the `ImportProductSets` method. + # Corresponds to the JSON property `inputConfig` + # @return [Google::Apis::VisionV1::ImportProductSetsInputConfig] + attr_accessor :input_config + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @input_config = args[:input_config] if args.key?(:input_config) + end + end + + # Response message for the `ImportProductSets` method. + # This message is returned by the + # google.longrunning.Operations.GetOperation method in the returned + # google.longrunning.Operation.response field. + class ImportProductSetsResponse + include Google::Apis::Core::Hashable + + # The list of reference_images that are imported successfully. + # Corresponds to the JSON property `referenceImages` + # @return [Array] + attr_accessor :reference_images + + # The rpc status for each ImportProductSet request, including both successes + # and errors. + # The number of statuses here matches the number of lines in the csv file, + # and statuses[i] stores the success or failure status of processing the i-th + # line of the csv, starting from line 0. + # Corresponds to the JSON property `statuses` + # @return [Array] + attr_accessor :statuses + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @reference_images = args[:reference_images] if args.key?(:reference_images) + @statuses = args[:statuses] if args.key?(:statuses) + end + end + # The desired input location and metadata. class InputConfig include Google::Apis::Core::Hashable @@ -6254,6 +6885,33 @@ module Google end end + # A product label represented as a key-value pair. + class KeyValue + include Google::Apis::Core::Hashable + + # The key of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # The value of the label attached to the product. Cannot be empty and + # cannot exceed 128 bytes. + # 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 + # A face-specific landmark (for example, a face feature). class Landmark include Google::Apis::Core::Hashable @@ -6368,6 +7026,115 @@ module Google end end + # Response message for the `ListProductSets` method. + class ListProductSetsResponse + 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 + + # List of ProductSets. + # Corresponds to the JSON property `productSets` + # @return [Array] + attr_accessor :product_sets + + 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) + @product_sets = args[:product_sets] if args.key?(:product_sets) + end + end + + # Response message for the `ListProductsInProductSet` method. + class ListProductsInProductSetResponse + 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 Products. + # Corresponds to the JSON property `products` + # @return [Array] + attr_accessor :products + + 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) + @products = args[:products] if args.key?(:products) + end + end + + # Response message for the `ListProducts` method. + class ListProductsResponse + 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 + + # List of products. + # Corresponds to the JSON property `products` + # @return [Array] + attr_accessor :products + + 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) + @products = args[:products] if args.key?(:products) + end + end + + # Response message for the `ListReferenceImages` method. + class ListReferenceImagesResponse + include Google::Apis::Core::Hashable + + # The next_page_token returned from a previous List request, if any. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # The maximum number of items to return. Default 10, maximum 100. + # Corresponds to the JSON property `pageSize` + # @return [Fixnum] + attr_accessor :page_size + + # The list of reference images. + # Corresponds to the JSON property `referenceImages` + # @return [Array] + attr_accessor :reference_images + + 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) + @page_size = args[:page_size] if args.key?(:page_size) + @reference_images = args[:reference_images] if args.key?(:reference_images) + end + end + # Set of detected objects with bounding boxes. class LocalizedObjectAnnotation include Google::Apis::Core::Hashable @@ -6739,6 +7506,226 @@ module Google end end + # A Product contains ReferenceImages. + class Product + include Google::Apis::Core::Hashable + + # User-provided metadata to be stored with this product. Must be at most 4096 + # characters long. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The user-provided name for this Product. Must not be empty. Must be at most + # 4096 characters long. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The resource name of the product. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + # This field is ignored when creating a product. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The category for the product identified by the reference image. This should + # be either "homegoods", "apparel", or "toys". + # This field is immutable. + # Corresponds to the JSON property `productCategory` + # @return [String] + attr_accessor :product_category + + # Key-value pairs that can be attached to a product. At query time, + # constraints can be specified based on the product_labels. + # Note that integer values can be provided as strings, e.g. "1199". Only + # strings with integer values can match a range-based restriction which is + # to be supported soon. + # Multiple values can be assigned to the same key. One product may have up to + # 100 product_labels. + # Corresponds to the JSON property `productLabels` + # @return [Array] + attr_accessor :product_labels + + 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) + @name = args[:name] if args.key?(:name) + @product_category = args[:product_category] if args.key?(:product_category) + @product_labels = args[:product_labels] if args.key?(:product_labels) + end + end + + # Parameters for a product search request. + class ProductSearchParams + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1::BoundingPoly] + attr_accessor :bounding_poly + + # The filtering expression. This can be used to restrict search results based + # on Product labels. We currently support an AND of OR of key-value + # expressions, where each expression within an OR must have the same key. + # For example, "(color = red OR color = blue) AND brand = Google" is + # acceptable, but not "(color = red OR brand = Google)" or "color: red". + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # The list of product categories to search in. Currently, we only consider + # the first category, and either "homegoods", "apparel", or "toys" should be + # specified. + # Corresponds to the JSON property `productCategories` + # @return [Array] + attr_accessor :product_categories + + # The resource name of a ProductSet to be searched for similar images. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + # Corresponds to the JSON property `productSet` + # @return [String] + attr_accessor :product_set + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @filter = args[:filter] if args.key?(:filter) + @product_categories = args[:product_categories] if args.key?(:product_categories) + @product_set = args[:product_set] if args.key?(:product_set) + end + end + + # Results for a product search request. + class ProductSearchResults + include Google::Apis::Core::Hashable + + # Timestamp of the index which provided these results. Changes made after + # this time are not reflected in the current results. + # Corresponds to the JSON property `indexTime` + # @return [String] + attr_accessor :index_time + + # List of results grouped by products detected in the query image. Each entry + # corresponds to one bounding polygon in the query image, and contains the + # matching products specific to that region. There may be duplicate product + # matches in the union of all the per-product results. + # Corresponds to the JSON property `productGroupedResults` + # @return [Array] + attr_accessor :product_grouped_results + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @index_time = args[:index_time] if args.key?(:index_time) + @product_grouped_results = args[:product_grouped_results] if args.key?(:product_grouped_results) + @results = args[:results] if args.key?(:results) + end + end + + # A ProductSet contains Products. A ProductSet can contain a maximum of 1 + # million reference images. If the limit is exceeded, periodic indexing will + # fail. + class ProductSet + include Google::Apis::Core::Hashable + + # The user-provided name for this ProductSet. Must not be empty. Must be at + # most 4096 characters long. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # 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 `indexError` + # @return [Google::Apis::VisionV1::Status] + attr_accessor :index_error + + # Output only. The time at which this ProductSet was last indexed. Query + # results will reflect all updates before this time. If this ProductSet has + # never been indexed, this field is 0. + # This field is ignored when creating a ProductSet. + # Corresponds to the JSON property `indexTime` + # @return [String] + attr_accessor :index_time + + # The resource name of the ProductSet. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + # This field is ignored when creating a ProductSet. + # 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) + @display_name = args[:display_name] if args.key?(:display_name) + @index_error = args[:index_error] if args.key?(:index_error) + @index_time = args[:index_time] if args.key?(:index_time) + @name = args[:name] if args.key?(:name) + end + end + # A `Property` consists of a user-supplied name/value pair. class Property include Google::Apis::Core::Hashable @@ -6770,6 +7757,104 @@ module Google end end + # A `ReferenceImage` represents a product image and its associated metadata, + # such as bounding boxes. + class ReferenceImage + include Google::Apis::Core::Hashable + + # Bounding polygons around the areas of interest in the reference image. + # Optional. If this field is empty, the system will try to detect regions of + # interest. At most 10 bounding polygons will be used. + # The provided shape is converted into a non-rotated rectangle. Once + # converted, the small edge of the rectangle must be greater than or equal + # to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 + # is not). + # Corresponds to the JSON property `boundingPolys` + # @return [Array] + attr_accessor :bounding_polys + + # The resource name of the reference image. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ + # IMAGE_ID`. + # This field is ignored when creating a reference image. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The Google Cloud Storage URI of the reference image. + # The URI must start with `gs://`. + # Required. + # 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) + @bounding_polys = args[:bounding_polys] if args.key?(:bounding_polys) + @name = args[:name] if args.key?(:name) + @uri = args[:uri] if args.key?(:uri) + end + end + + # Request message for the `RemoveProductFromProductSet` method. + class RemoveProductFromProductSetRequest + include Google::Apis::Core::Hashable + + # The resource name for the Product to be removed from this ProductSet. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + # Corresponds to the JSON property `product` + # @return [String] + attr_accessor :product + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @product = args[:product] if args.key?(:product) + end + end + + # Information about a product. + class Result + include Google::Apis::Core::Hashable + + # The resource name of the image from the product that is the closest match + # to the query. + # Corresponds to the JSON property `image` + # @return [String] + attr_accessor :image + + # A Product contains ReferenceImages. + # Corresponds to the JSON property `product` + # @return [Google::Apis::VisionV1::Product] + attr_accessor :product + + # A confidence level on the match, ranging from 0 (no confidence) to + # 1 (full confidence). + # 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) + @image = args[:image] if args.key?(:image) + @product = args[:product] if args.key?(:product) + @score = args[:score] if args.key?(:score) + end + end + # Set of features pertaining to the image, computed by computer vision # methods over safe-search verticals (for example, adult, spoof, medical, # violence). diff --git a/generated/google/apis/vision_v1/representations.rb b/generated/google/apis/vision_v1/representations.rb index 257b30d5f..18b63dadc 100644 --- a/generated/google/apis/vision_v1/representations.rb +++ b/generated/google/apis/vision_v1/representations.rb @@ -22,6 +22,12 @@ module Google module Apis module VisionV1 + class AddProductToProductSetRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AnnotateFileResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -76,6 +82,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class BatchOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Block class Representation < Google::Apis::Core::JsonRepresentation; end @@ -328,6 +340,36 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVisionV1p1beta1Product + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ProductKeyValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ProductSearchResults + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ProductSearchResultsResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVisionV1p1beta1Property class Representation < Google::Apis::Core::JsonRepresentation; end @@ -568,6 +610,36 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVisionV1p2beta1Product + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p2beta1ProductKeyValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p2beta1ProductSearchResults + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p2beta1ProductSearchResultsResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVisionV1p2beta1Property class Representation < Google::Apis::Core::JsonRepresentation; end @@ -838,6 +910,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVisionV1p3beta1ProductSearchResultsResult class Representation < Google::Apis::Core::JsonRepresentation; end @@ -934,6 +1012,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GroupedResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Image class Representation < Google::Apis::Core::JsonRepresentation; end @@ -964,12 +1048,42 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ImportProductSetsGcsSource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImportProductSetsInputConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImportProductSetsRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ImportProductSetsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class InputConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class KeyValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Landmark class Representation < Google::Apis::Core::JsonRepresentation; end @@ -994,6 +1108,30 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ListProductSetsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListProductsInProductSetResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListProductsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ListReferenceImagesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class LocalizedObjectAnnotation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1048,12 +1186,54 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Product + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ProductSearchParams + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ProductSearchResults + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ProductSet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Property class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class ReferenceImage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RemoveProductFromProductSetRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Result + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SafeSearchAnnotation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1132,6 +1312,13 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class AddProductToProductSetRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :product, as: 'product' + end + end + class AnnotateFileResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1177,6 +1364,8 @@ module Google collection :logo_annotations, as: 'logoAnnotations', class: Google::Apis::VisionV1::EntityAnnotation, decorator: Google::Apis::VisionV1::EntityAnnotation::Representation + property :product_search_results, as: 'productSearchResults', class: Google::Apis::VisionV1::ProductSearchResults, decorator: Google::Apis::VisionV1::ProductSearchResults::Representation + property :safe_search_annotation, as: 'safeSearchAnnotation', class: Google::Apis::VisionV1::SafeSearchAnnotation, decorator: Google::Apis::VisionV1::SafeSearchAnnotation::Representation collection :text_annotations, as: 'textAnnotations', class: Google::Apis::VisionV1::EntityAnnotation, decorator: Google::Apis::VisionV1::EntityAnnotation::Representation @@ -1240,6 +1429,15 @@ module Google end end + class BatchOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + property :state, as: 'state' + property :submit_time, as: 'submitTime' + end + end + class Block # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1443,6 +1641,8 @@ module Google collection :logo_annotations, as: 'logoAnnotations', class: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1EntityAnnotation, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1EntityAnnotation::Representation + property :product_search_results, as: 'productSearchResults', class: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ProductSearchResults, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ProductSearchResults::Representation + property :safe_search_annotation, as: 'safeSearchAnnotation', class: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1SafeSearchAnnotation, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1SafeSearchAnnotation::Representation collection :text_annotations, as: 'textAnnotations', class: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1EntityAnnotation, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1EntityAnnotation::Representation @@ -1689,6 +1889,57 @@ module Google end end + class GoogleCloudVisionV1p1beta1Product + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + property :name, as: 'name' + property :product_category, as: 'productCategory' + collection :product_labels, as: 'productLabels', class: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ProductKeyValue, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ProductKeyValue::Representation + + end + end + + class GoogleCloudVisionV1p1beta1ProductKeyValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + + class GoogleCloudVisionV1p1beta1ProductSearchResults + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :index_time, as: 'indexTime' + collection :product_grouped_results, as: 'productGroupedResults', class: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1BoundingPoly, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1BoundingPoly::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p1beta1ProductSearchResultsResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image, as: 'image' + property :product, as: 'product', class: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1Product, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1Product::Representation + + property :score, as: 'score' + end + end + class GoogleCloudVisionV1p1beta1Property # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1866,6 +2117,8 @@ module Google collection :logo_annotations, as: 'logoAnnotations', class: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1EntityAnnotation, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1EntityAnnotation::Representation + property :product_search_results, as: 'productSearchResults', class: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1ProductSearchResults, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1ProductSearchResults::Representation + property :safe_search_annotation, as: 'safeSearchAnnotation', class: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1SafeSearchAnnotation, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1SafeSearchAnnotation::Representation collection :text_annotations, as: 'textAnnotations', class: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1EntityAnnotation, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1EntityAnnotation::Representation @@ -2122,6 +2375,57 @@ module Google end end + class GoogleCloudVisionV1p2beta1Product + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + property :name, as: 'name' + property :product_category, as: 'productCategory' + collection :product_labels, as: 'productLabels', class: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1ProductKeyValue, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1ProductKeyValue::Representation + + end + end + + class GoogleCloudVisionV1p2beta1ProductKeyValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + + class GoogleCloudVisionV1p2beta1ProductSearchResults + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :index_time, as: 'indexTime' + collection :product_grouped_results, as: 'productGroupedResults', class: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1BoundingPoly, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1BoundingPoly::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p2beta1ProductSearchResultsResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image, as: 'image' + property :product, as: 'product', class: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1Product, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1Product::Representation + + property :score, as: 'score' + end + end + class GoogleCloudVisionV1p2beta1Property # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2600,6 +2904,18 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :index_time, as: 'indexTime' + collection :product_grouped_results, as: 'productGroupedResults', class: Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1BoundingPoly, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1BoundingPoly::Representation + collection :results, as: 'results', class: Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1ProductSearchResultsResult::Representation end @@ -2769,6 +3085,16 @@ module Google end end + class GroupedResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1::BoundingPoly, decorator: Google::Apis::VisionV1::BoundingPoly::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1::Result, decorator: Google::Apis::VisionV1::Result::Representation + + end + end + class Image # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2794,6 +3120,8 @@ module Google collection :language_hints, as: 'languageHints' property :lat_long_rect, as: 'latLongRect', class: Google::Apis::VisionV1::LatLongRect, decorator: Google::Apis::VisionV1::LatLongRect::Representation + property :product_search_params, as: 'productSearchParams', class: Google::Apis::VisionV1::ProductSearchParams, decorator: Google::Apis::VisionV1::ProductSearchParams::Representation + property :web_detection_params, as: 'webDetectionParams', class: Google::Apis::VisionV1::WebDetectionParams, decorator: Google::Apis::VisionV1::WebDetectionParams::Representation end @@ -2815,6 +3143,39 @@ module Google end end + class ImportProductSetsGcsSource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :csv_file_uri, as: 'csvFileUri' + end + end + + class ImportProductSetsInputConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :gcs_source, as: 'gcsSource', class: Google::Apis::VisionV1::ImportProductSetsGcsSource, decorator: Google::Apis::VisionV1::ImportProductSetsGcsSource::Representation + + end + end + + class ImportProductSetsRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :input_config, as: 'inputConfig', class: Google::Apis::VisionV1::ImportProductSetsInputConfig, decorator: Google::Apis::VisionV1::ImportProductSetsInputConfig::Representation + + end + end + + class ImportProductSetsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :reference_images, as: 'referenceImages', class: Google::Apis::VisionV1::ReferenceImage, decorator: Google::Apis::VisionV1::ReferenceImage::Representation + + collection :statuses, as: 'statuses', class: Google::Apis::VisionV1::Status, decorator: Google::Apis::VisionV1::Status::Representation + + end + end + class InputConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2824,6 +3185,14 @@ module Google end end + class KeyValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + class Landmark # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2860,6 +3229,43 @@ module Google end end + class ListProductSetsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :product_sets, as: 'productSets', class: Google::Apis::VisionV1::ProductSet, decorator: Google::Apis::VisionV1::ProductSet::Representation + + end + end + + class ListProductsInProductSetResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :products, as: 'products', class: Google::Apis::VisionV1::Product, decorator: Google::Apis::VisionV1::Product::Representation + + end + end + + class ListProductsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :products, as: 'products', class: Google::Apis::VisionV1::Product, decorator: Google::Apis::VisionV1::Product::Representation + + end + end + + class ListReferenceImagesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + property :page_size, as: 'pageSize' + collection :reference_images, as: 'referenceImages', class: Google::Apis::VisionV1::ReferenceImage, decorator: Google::Apis::VisionV1::ReferenceImage::Representation + + end + end + class LocalizedObjectAnnotation # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2953,6 +3359,51 @@ module Google end end + class Product + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + property :name, as: 'name' + property :product_category, as: 'productCategory' + collection :product_labels, as: 'productLabels', class: Google::Apis::VisionV1::KeyValue, decorator: Google::Apis::VisionV1::KeyValue::Representation + + end + end + + class ProductSearchParams + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1::BoundingPoly, decorator: Google::Apis::VisionV1::BoundingPoly::Representation + + property :filter, as: 'filter' + collection :product_categories, as: 'productCategories' + property :product_set, as: 'productSet' + end + end + + class ProductSearchResults + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :index_time, as: 'indexTime' + collection :product_grouped_results, as: 'productGroupedResults', class: Google::Apis::VisionV1::GroupedResult, decorator: Google::Apis::VisionV1::GroupedResult::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1::Result, decorator: Google::Apis::VisionV1::Result::Representation + + end + end + + class ProductSet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :index_error, as: 'indexError', class: Google::Apis::VisionV1::Status, decorator: Google::Apis::VisionV1::Status::Representation + + property :index_time, as: 'indexTime' + property :name, as: 'name' + end + end + class Property # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2962,6 +3413,33 @@ module Google end end + class ReferenceImage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :bounding_polys, as: 'boundingPolys', class: Google::Apis::VisionV1::BoundingPoly, decorator: Google::Apis::VisionV1::BoundingPoly::Representation + + property :name, as: 'name' + property :uri, as: 'uri' + end + end + + class RemoveProductFromProductSetRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :product, as: 'product' + end + end + + class Result + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image, as: 'image' + property :product, as: 'product', class: Google::Apis::VisionV1::Product, decorator: Google::Apis::VisionV1::Product::Representation + + property :score, as: 'score' + end + end + class SafeSearchAnnotation # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/vision_v1/service.rb b/generated/google/apis/vision_v1/service.rb index e51dec254..328b8e4f7 100644 --- a/generated/google/apis/vision_v1/service.rb +++ b/generated/google/apis/vision_v1/service.rb @@ -299,6 +299,750 @@ module Google command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end + + # Adds a Product to the specified ProductSet. If the Product is already + # present, no change is made. + # One Product can be added to at most 100 ProductSets. + # Possible errors: + # * Returns NOT_FOUND if the Product or the ProductSet doesn't exist. + # @param [String] name + # The resource name for the ProductSet to modify. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + # @param [Google::Apis::VisionV1::AddProductToProductSetRequest] add_product_to_product_set_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::VisionV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::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 add_product_to_product_set(name, add_product_to_product_set_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:addProduct', options) + command.request_representation = Google::Apis::VisionV1::AddProductToProductSetRequest::Representation + command.request_object = add_product_to_product_set_request_object + command.response_representation = Google::Apis::VisionV1::Empty::Representation + command.response_class = Google::Apis::VisionV1::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 + + # Creates and returns a new ProductSet resource. + # Possible errors: + # * Returns INVALID_ARGUMENT if display_name is missing, or is longer than + # 4096 characters. + # @param [String] parent + # The project in which the ProductSet should be created. + # Format is `projects/PROJECT_ID/locations/LOC_ID`. + # @param [Google::Apis::VisionV1::ProductSet] product_set_object + # @param [String] product_set_id + # A user-supplied resource id for this ProductSet. If set, the server will + # attempt to use this value as the resource id. If it is already in use, an + # error is returned with code ALREADY_EXISTS. Must be at most 128 characters + # long. It cannot contain the character `/`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::VisionV1::ProductSet] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::ProductSet] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product_set(parent, product_set_object = nil, product_set_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/productSets', options) + command.request_representation = Google::Apis::VisionV1::ProductSet::Representation + command.request_object = product_set_object + command.response_representation = Google::Apis::VisionV1::ProductSet::Representation + command.response_class = Google::Apis::VisionV1::ProductSet + command.params['parent'] = parent unless parent.nil? + command.query['productSetId'] = product_set_id unless product_set_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 + + # Permanently deletes a ProductSet. All Products and ReferenceImages in the + # ProductSet will be deleted. + # The actual image files are not deleted from Google Cloud Storage. + # Possible errors: + # * Returns NOT_FOUND if the ProductSet does not exist. + # @param [String] name + # Resource name of the ProductSet to delete. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_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::VisionV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::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_product_set(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::VisionV1::Empty::Representation + command.response_class = Google::Apis::VisionV1::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 information associated with a ProductSet. + # Possible errors: + # * Returns NOT_FOUND if the ProductSet does not exist. + # @param [String] name + # Resource name of the ProductSet to get. + # Format is: + # `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_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::VisionV1::ProductSet] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::ProductSet] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product_set(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::VisionV1::ProductSet::Representation + command.response_class = Google::Apis::VisionV1::ProductSet + 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 + + # Asynchronous API that imports a list of reference images to specified + # product sets based on a list of image information. + # The google.longrunning.Operation API can be used to keep track of the + # progress and results of the request. + # `Operation.metadata` contains `BatchOperationMetadata`. (progress) + # `Operation.response` contains `ImportProductSetsResponse`. (results) + # The input source of this method is a csv file on Google Cloud Storage. + # For the format of the csv file please see + # ImportProductSetsGcsSource.csv_file_uri. + # @param [String] parent + # The project in which the ProductSets should be imported. + # Format is `projects/PROJECT_ID/locations/LOC_ID`. + # @param [Google::Apis::VisionV1::ImportProductSetsRequest] import_product_sets_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::VisionV1::Operation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::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_product_sets(parent, import_product_sets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/productSets:import', options) + command.request_representation = Google::Apis::VisionV1::ImportProductSetsRequest::Representation + command.request_object = import_product_sets_request_object + command.response_representation = Google::Apis::VisionV1::Operation::Representation + command.response_class = Google::Apis::VisionV1::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 + + # Lists ProductSets in an unspecified order. + # Possible errors: + # * Returns INVALID_ARGUMENT if page_size is greater than 100, or less + # than 1. + # @param [String] parent + # The project from which ProductSets should be listed. + # Format is `projects/PROJECT_ID/locations/LOC_ID`. + # @param [Fixnum] page_size + # The maximum number of items to return. Default 10, maximum 100. + # @param [String] page_token + # The next_page_token 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::VisionV1::ListProductSetsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::ListProductSetsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product_sets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/productSets', options) + command.response_representation = Google::Apis::VisionV1::ListProductSetsResponse::Representation + command.response_class = Google::Apis::VisionV1::ListProductSetsResponse + 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 + + # Makes changes to a ProductSet resource. + # Only display_name can be updated currently. + # Possible errors: + # * Returns NOT_FOUND if the ProductSet does not exist. + # * Returns INVALID_ARGUMENT if display_name is present in update_mask but + # missing from the request or longer than 4096 characters. + # @param [String] name + # The resource name of the ProductSet. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + # This field is ignored when creating a ProductSet. + # @param [Google::Apis::VisionV1::ProductSet] product_set_object + # @param [String] update_mask + # The FieldMask that specifies which fields to + # update. + # If update_mask isn't specified, all mutable fields are to be updated. + # Valid mask path is `display_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::VisionV1::ProductSet] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::ProductSet] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product_set(name, product_set_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::VisionV1::ProductSet::Representation + command.request_object = product_set_object + command.response_representation = Google::Apis::VisionV1::ProductSet::Representation + command.response_class = Google::Apis::VisionV1::ProductSet + 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 + + # Removes a Product from the specified ProductSet. + # Possible errors: + # * Returns NOT_FOUND If the Product is not found under the ProductSet. + # @param [String] name + # The resource name for the ProductSet to modify. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + # @param [Google::Apis::VisionV1::RemoveProductFromProductSetRequest] remove_product_from_product_set_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::VisionV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::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 remove_product_from_product_set(name, remove_product_from_product_set_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+name}:removeProduct', options) + command.request_representation = Google::Apis::VisionV1::RemoveProductFromProductSetRequest::Representation + command.request_object = remove_product_from_product_set_request_object + command.response_representation = Google::Apis::VisionV1::Empty::Representation + command.response_class = Google::Apis::VisionV1::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 + + # Lists the Products in a ProductSet, in an unspecified order. If the + # ProductSet does not exist, the products field of the response will be + # empty. + # Possible errors: + # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. + # @param [String] name + # The ProductSet resource for which to retrieve Products. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + # @param [Fixnum] page_size + # The maximum number of items to return. Default 10, maximum 100. + # @param [String] page_token + # The next_page_token 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::VisionV1::ListProductsInProductSetResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::ListProductsInProductSetResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product_set_products(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}/products', options) + command.response_representation = Google::Apis::VisionV1::ListProductsInProductSetResponse::Representation + command.response_class = Google::Apis::VisionV1::ListProductsInProductSetResponse + command.params['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['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates and returns a new product resource. + # Possible errors: + # * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 + # characters. + # * Returns INVALID_ARGUMENT if description is longer than 4096 characters. + # * Returns INVALID_ARGUMENT if product_category is missing or invalid. + # @param [String] parent + # The project in which the Product should be created. + # Format is + # `projects/PROJECT_ID/locations/LOC_ID`. + # @param [Google::Apis::VisionV1::Product] product_object + # @param [String] product_id + # A user-supplied resource id for this Product. If set, the server will + # attempt to use this value as the resource id. If it is already in use, an + # error is returned with code ALREADY_EXISTS. Must be at most 128 characters + # long. It cannot contain the character `/`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::VisionV1::Product] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::Product] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product(parent, product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/products', options) + command.request_representation = Google::Apis::VisionV1::Product::Representation + command.request_object = product_object + command.response_representation = Google::Apis::VisionV1::Product::Representation + command.response_class = Google::Apis::VisionV1::Product + command.params['parent'] = parent unless parent.nil? + command.query['productId'] = product_id unless product_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 + + # Permanently deletes a product and its reference images. + # Metadata of the product and all its images will be deleted right away, but + # search queries against ProductSets containing the product may still work + # until all related caches are refreshed. + # Possible errors: + # * Returns NOT_FOUND if the product does not exist. + # @param [String] name + # Resource name of product to delete. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_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::VisionV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::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_product(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::VisionV1::Empty::Representation + command.response_class = Google::Apis::VisionV1::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 information associated with a Product. + # Possible errors: + # * Returns NOT_FOUND if the Product does not exist. + # @param [String] name + # Resource name of the Product to get. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_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::VisionV1::Product] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::Product] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::VisionV1::Product::Representation + command.response_class = Google::Apis::VisionV1::Product + 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 products in an unspecified order. + # Possible errors: + # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. + # @param [String] parent + # The project OR ProductSet from which Products should be listed. + # Format: + # `projects/PROJECT_ID/locations/LOC_ID` + # @param [Fixnum] page_size + # The maximum number of items to return. Default 10, maximum 100. + # @param [String] page_token + # The next_page_token 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::VisionV1::ListProductsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::ListProductsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_products(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/products', options) + command.response_representation = Google::Apis::VisionV1::ListProductsResponse::Representation + command.response_class = Google::Apis::VisionV1::ListProductsResponse + 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 + + # Makes changes to a Product resource. + # Only the `display_name`, `description`, and `labels` fields can be updated + # right now. + # If labels are updated, the change will not be reflected in queries until + # the next index time. + # Possible errors: + # * Returns NOT_FOUND if the Product does not exist. + # * Returns INVALID_ARGUMENT if display_name is present in update_mask but is + # missing from the request or longer than 4096 characters. + # * Returns INVALID_ARGUMENT if description is present in update_mask but is + # longer than 4096 characters. + # * Returns INVALID_ARGUMENT if product_category is present in update_mask. + # @param [String] name + # The resource name of the product. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + # This field is ignored when creating a product. + # @param [Google::Apis::VisionV1::Product] product_object + # @param [String] update_mask + # The FieldMask that specifies which fields + # to update. + # If update_mask isn't specified, all mutable fields are to be updated. + # Valid mask paths include `product_labels`, `display_name`, and + # `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::VisionV1::Product] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::Product] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product(name, product_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::VisionV1::Product::Representation + command.request_object = product_object + command.response_representation = Google::Apis::VisionV1::Product::Representation + command.response_class = Google::Apis::VisionV1::Product + 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 and returns a new ReferenceImage resource. + # The `bounding_poly` field is optional. If `bounding_poly` is not specified, + # the system will try to detect regions of interest in the image that are + # compatible with the product_category on the parent product. If it is + # specified, detection is ALWAYS skipped. The system converts polygons into + # non-rotated rectangles. + # Note that the pipeline will resize the image if the image resolution is too + # large to process (above 50MP). + # Possible errors: + # * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 + # characters. + # * Returns INVALID_ARGUMENT if the product does not exist. + # * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing + # compatible with the parent product's product_category is detected. + # * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons. + # @param [String] parent + # Resource name of the product in which to create the reference image. + # Format is + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + # @param [Google::Apis::VisionV1::ReferenceImage] reference_image_object + # @param [String] reference_image_id + # A user-supplied resource id for the ReferenceImage to be added. If set, + # the server will attempt to use this value as the resource id. If it is + # already in use, an error is returned with code ALREADY_EXISTS. Must be at + # most 128 characters long. It cannot contain the character `/`. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::VisionV1::ReferenceImage] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::ReferenceImage] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product_reference_image(parent, reference_image_object = nil, reference_image_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/{+parent}/referenceImages', options) + command.request_representation = Google::Apis::VisionV1::ReferenceImage::Representation + command.request_object = reference_image_object + command.response_representation = Google::Apis::VisionV1::ReferenceImage::Representation + command.response_class = Google::Apis::VisionV1::ReferenceImage + command.params['parent'] = parent unless parent.nil? + command.query['referenceImageId'] = reference_image_id unless reference_image_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 + + # Permanently deletes a reference image. + # The image metadata will be deleted right away, but search queries + # against ProductSets containing the image may still work until all related + # caches are refreshed. + # The actual image files are not deleted from Google Cloud Storage. + # Possible errors: + # * Returns NOT_FOUND if the reference image does not exist. + # @param [String] name + # The resource name of the reference image to delete. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ + # IMAGE_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::VisionV1::Empty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::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_product_reference_image(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+name}', options) + command.response_representation = Google::Apis::VisionV1::Empty::Representation + command.response_class = Google::Apis::VisionV1::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 information associated with a ReferenceImage. + # Possible errors: + # * Returns NOT_FOUND if the specified image does not exist. + # @param [String] name + # The resource name of the ReferenceImage to get. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ + # IMAGE_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::VisionV1::ReferenceImage] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::ReferenceImage] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product_reference_image(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}', options) + command.response_representation = Google::Apis::VisionV1::ReferenceImage::Representation + command.response_class = Google::Apis::VisionV1::ReferenceImage + 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 reference images. + # Possible errors: + # * Returns NOT_FOUND if the parent product does not exist. + # * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less + # than 1. + # @param [String] parent + # Resource name of the product containing the reference images. + # Format is + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + # @param [Fixnum] page_size + # The maximum number of items to return. Default 10, maximum 100. + # @param [String] page_token + # A token identifying a page of results to be returned. This is the value + # of `nextPageToken` returned in a previous reference image list request. + # Defaults to the first page if not specified. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available 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::VisionV1::ListReferenceImagesResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::VisionV1::ListReferenceImagesResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be 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_product_reference_images(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+parent}/referenceImages', options) + command.response_representation = Google::Apis::VisionV1::ListReferenceImagesResponse::Representation + command.response_class = Google::Apis::VisionV1::ListReferenceImagesResponse + 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 protected diff --git a/generated/google/apis/vision_v1p1beta1.rb b/generated/google/apis/vision_v1p1beta1.rb index 8bb1e85b4..845c23c3d 100644 --- a/generated/google/apis/vision_v1p1beta1.rb +++ b/generated/google/apis/vision_v1p1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/vision/ module VisionV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20180928' + REVISION = '20181031' # 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_v1p1beta1/classes.rb b/generated/google/apis/vision_v1p1beta1/classes.rb index cd127cc87..bd267ef7d 100644 --- a/generated/google/apis/vision_v1p1beta1/classes.rb +++ b/generated/google/apis/vision_v1p1beta1/classes.rb @@ -148,6 +148,11 @@ module Google # @return [Array] attr_accessor :logo_annotations + # Results for a product search request. + # Corresponds to the JSON property `productSearchResults` + # @return [Google::Apis::VisionV1p1beta1::ProductSearchResults] + attr_accessor :product_search_results + # Set of features pertaining to the image, computed by computer vision # methods over safe-search verticals (for example, adult, spoof, medical, # violence). @@ -181,6 +186,7 @@ module Google @landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations) @localized_object_annotations = args[:localized_object_annotations] if args.key?(:localized_object_annotations) @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations) + @product_search_results = args[:product_search_results] if args.key?(:product_search_results) @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) @@ -226,6 +232,40 @@ module Google end end + # Metadata for the batch operations such as the current state. + # This is included in the `metadata` field of the `Operation` returned by the + # `GetOperation` call of the `google::longrunning::Operations` service. + class BatchOperationMetadata + include Google::Apis::Core::Hashable + + # The time when the batch request is finished and + # google.longrunning.Operation.done is set to true. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # The current state of the batch operation. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # The time when the batch request was submitted to the server. + # Corresponds to the JSON property `submitTime` + # @return [String] + attr_accessor :submit_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_time = args[:end_time] if args.key?(:end_time) + @state = args[:state] if args.key?(:state) + @submit_time = args[:submit_time] if args.key?(:submit_time) + end + end + # Logical element on the page. class Block include Google::Apis::Core::Hashable @@ -1090,6 +1130,11 @@ module Google # @return [Array] attr_accessor :logo_annotations + # Results for a product search request. + # Corresponds to the JSON property `productSearchResults` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductSearchResults] + attr_accessor :product_search_results + # Set of features pertaining to the image, computed by computer vision # methods over safe-search verticals (for example, adult, spoof, medical, # violence). @@ -1123,6 +1168,7 @@ module Google @landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations) @localized_object_annotations = args[:localized_object_annotations] if args.key?(:localized_object_annotations) @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations) + @product_search_results = args[:product_search_results] if args.key?(:product_search_results) @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) @@ -1935,6 +1981,11 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1LatLongRect] attr_accessor :lat_long_rect + # Parameters for a product search request. + # Corresponds to the JSON property `productSearchParams` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductSearchParams] + attr_accessor :product_search_params + # Parameters for web detection request. # Corresponds to the JSON property `webDetectionParams` # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionParams] @@ -1949,6 +2000,7 @@ module Google @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) + @product_search_params = args[:product_search_params] if args.key?(:product_search_params) @web_detection_params = args[:web_detection_params] if args.key?(:web_detection_params) end end @@ -2320,6 +2372,228 @@ module Google end end + # A Product contains ReferenceImages. + class GoogleCloudVisionV1p1beta1Product + include Google::Apis::Core::Hashable + + # User-provided metadata to be stored with this product. Must be at most 4096 + # characters long. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The user-provided name for this Product. Must not be empty. Must be at most + # 4096 characters long. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The resource name of the product. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + # This field is ignored when creating a product. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The category for the product identified by the reference image. This should + # be either "homegoods", "apparel", or "toys". + # This field is immutable. + # Corresponds to the JSON property `productCategory` + # @return [String] + attr_accessor :product_category + + # Key-value pairs that can be attached to a product. At query time, + # constraints can be specified based on the product_labels. + # Note that integer values can be provided as strings, e.g. "1199". Only + # strings with integer values can match a range-based restriction which is + # to be supported soon. + # Multiple values can be assigned to the same key. One product may have up to + # 100 product_labels. + # Corresponds to the JSON property `productLabels` + # @return [Array] + attr_accessor :product_labels + + 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) + @name = args[:name] if args.key?(:name) + @product_category = args[:product_category] if args.key?(:product_category) + @product_labels = args[:product_labels] if args.key?(:product_labels) + end + end + + # A product label represented as a key-value pair. + class GoogleCloudVisionV1p1beta1ProductKeyValue + include Google::Apis::Core::Hashable + + # The key of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # The value of the label attached to the product. Cannot be empty and + # cannot exceed 128 bytes. + # 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 + + # Parameters for a product search request. + class GoogleCloudVisionV1p1beta1ProductSearchParams + 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 filtering expression. This can be used to restrict search results based + # on Product labels. We currently support an AND of OR of key-value + # expressions, where each expression within an OR must have the same key. + # For example, "(color = red OR color = blue) AND brand = Google" is + # acceptable, but not "(color = red OR brand = Google)" or "color: red". + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # The list of product categories to search in. Currently, we only consider + # the first category, and either "homegoods", "apparel", or "toys" should be + # specified. + # Corresponds to the JSON property `productCategories` + # @return [Array] + attr_accessor :product_categories + + # The resource name of a ProductSet to be searched for similar images. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + # Corresponds to the JSON property `productSet` + # @return [String] + attr_accessor :product_set + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @filter = args[:filter] if args.key?(:filter) + @product_categories = args[:product_categories] if args.key?(:product_categories) + @product_set = args[:product_set] if args.key?(:product_set) + end + end + + # Results for a product search request. + class GoogleCloudVisionV1p1beta1ProductSearchResults + include Google::Apis::Core::Hashable + + # Timestamp of the index which provided these results. Changes made after + # this time are not reflected in the current results. + # Corresponds to the JSON property `indexTime` + # @return [String] + attr_accessor :index_time + + # List of results grouped by products detected in the query image. Each entry + # corresponds to one bounding polygon in the query image, and contains the + # matching products specific to that region. There may be duplicate product + # matches in the union of all the per-product results. + # Corresponds to the JSON property `productGroupedResults` + # @return [Array] + attr_accessor :product_grouped_results + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @index_time = args[:index_time] if args.key?(:index_time) + @product_grouped_results = args[:product_grouped_results] if args.key?(:product_grouped_results) + @results = args[:results] if args.key?(:results) + end + end + + # Information about the products similar to a single product in a query + # image. + class GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult + 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 + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @results = args[:results] if args.key?(:results) + end + end + + # Information about a product. + class GoogleCloudVisionV1p1beta1ProductSearchResultsResult + include Google::Apis::Core::Hashable + + # The resource name of the image from the product that is the closest match + # to the query. + # Corresponds to the JSON property `image` + # @return [String] + attr_accessor :image + + # A Product contains ReferenceImages. + # Corresponds to the JSON property `product` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Product] + attr_accessor :product + + # A confidence level on the match, ranging from 0 (no confidence) to + # 1 (full confidence). + # 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) + @image = args[:image] if args.key?(:image) + @product = args[:product] if args.key?(:product) + @score = args[:score] if args.key?(:score) + end + end + # A `Property` consists of a user-supplied name/value pair. class GoogleCloudVisionV1p1beta1Property include Google::Apis::Core::Hashable @@ -2943,6 +3217,11 @@ module Google # @return [Array] attr_accessor :logo_annotations + # Results for a product search request. + # Corresponds to the JSON property `productSearchResults` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ProductSearchResults] + attr_accessor :product_search_results + # Set of features pertaining to the image, computed by computer vision # methods over safe-search verticals (for example, adult, spoof, medical, # violence). @@ -2976,6 +3255,7 @@ module Google @landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations) @localized_object_annotations = args[:localized_object_annotations] if args.key?(:localized_object_annotations) @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations) + @product_search_results = args[:product_search_results] if args.key?(:product_search_results) @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) @@ -3904,6 +4184,183 @@ module Google end end + # A Product contains ReferenceImages. + class GoogleCloudVisionV1p2beta1Product + include Google::Apis::Core::Hashable + + # User-provided metadata to be stored with this product. Must be at most 4096 + # characters long. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The user-provided name for this Product. Must not be empty. Must be at most + # 4096 characters long. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The resource name of the product. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + # This field is ignored when creating a product. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The category for the product identified by the reference image. This should + # be either "homegoods", "apparel", or "toys". + # This field is immutable. + # Corresponds to the JSON property `productCategory` + # @return [String] + attr_accessor :product_category + + # Key-value pairs that can be attached to a product. At query time, + # constraints can be specified based on the product_labels. + # Note that integer values can be provided as strings, e.g. "1199". Only + # strings with integer values can match a range-based restriction which is + # to be supported soon. + # Multiple values can be assigned to the same key. One product may have up to + # 100 product_labels. + # Corresponds to the JSON property `productLabels` + # @return [Array] + attr_accessor :product_labels + + 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) + @name = args[:name] if args.key?(:name) + @product_category = args[:product_category] if args.key?(:product_category) + @product_labels = args[:product_labels] if args.key?(:product_labels) + end + end + + # A product label represented as a key-value pair. + class GoogleCloudVisionV1p2beta1ProductKeyValue + include Google::Apis::Core::Hashable + + # The key of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # The value of the label attached to the product. Cannot be empty and + # cannot exceed 128 bytes. + # 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 + + # Results for a product search request. + class GoogleCloudVisionV1p2beta1ProductSearchResults + include Google::Apis::Core::Hashable + + # Timestamp of the index which provided these results. Changes made after + # this time are not reflected in the current results. + # Corresponds to the JSON property `indexTime` + # @return [String] + attr_accessor :index_time + + # List of results grouped by products detected in the query image. Each entry + # corresponds to one bounding polygon in the query image, and contains the + # matching products specific to that region. There may be duplicate product + # matches in the union of all the per-product results. + # Corresponds to the JSON property `productGroupedResults` + # @return [Array] + attr_accessor :product_grouped_results + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @index_time = args[:index_time] if args.key?(:index_time) + @product_grouped_results = args[:product_grouped_results] if args.key?(:product_grouped_results) + @results = args[:results] if args.key?(:results) + end + end + + # Information about the products similar to a single product in a query + # image. + class GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1BoundingPoly] + attr_accessor :bounding_poly + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @results = args[:results] if args.key?(:results) + end + end + + # Information about a product. + class GoogleCloudVisionV1p2beta1ProductSearchResultsResult + include Google::Apis::Core::Hashable + + # The resource name of the image from the product that is the closest match + # to the query. + # Corresponds to the JSON property `image` + # @return [String] + attr_accessor :image + + # A Product contains ReferenceImages. + # Corresponds to the JSON property `product` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1Product] + attr_accessor :product + + # A confidence level on the match, ranging from 0 (no confidence) to + # 1 (full confidence). + # 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) + @image = args[:image] if args.key?(:image) + @product = args[:product] if args.key?(:product) + @score = args[:score] if args.key?(:score) + end + end + # A `Property` consists of a user-supplied name/value pair. class GoogleCloudVisionV1p2beta1Property include Google::Apis::Core::Hashable @@ -5633,6 +6090,14 @@ module Google # @return [String] attr_accessor :index_time + # List of results grouped by products detected in the query image. Each entry + # corresponds to one bounding polygon in the query image, and contains the + # matching products specific to that region. There may be duplicate product + # matches in the union of all the per-product results. + # Corresponds to the JSON property `productGroupedResults` + # @return [Array] + attr_accessor :product_grouped_results + # List of results, one for each product match. # Corresponds to the JSON property `results` # @return [Array] @@ -5645,6 +6110,33 @@ module Google # Update properties of this object def update!(**args) @index_time = args[:index_time] if args.key?(:index_time) + @product_grouped_results = args[:product_grouped_results] if args.key?(:product_grouped_results) + @results = args[:results] if args.key?(:results) + end + end + + # Information about the products similar to a single product in a query + # image. + class GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1BoundingPoly] + attr_accessor :bounding_poly + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) @results = args[:results] if args.key?(:results) end end @@ -6203,6 +6695,32 @@ module Google end end + # Information about the products similar to a single product in a query + # image. + class GroupedResult + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1p1beta1::BoundingPoly] + attr_accessor :bounding_poly + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @results = args[:results] if args.key?(:results) + end + end + # If an image was produced from a file (e.g. a PDF), this message gives # information about the source of that image. class ImageAnnotationContext @@ -6249,6 +6767,38 @@ module Google end end + # Response message for the `ImportProductSets` method. + # This message is returned by the + # google.longrunning.Operations.GetOperation method in the returned + # google.longrunning.Operation.response field. + class ImportProductSetsResponse + include Google::Apis::Core::Hashable + + # The list of reference_images that are imported successfully. + # Corresponds to the JSON property `referenceImages` + # @return [Array] + attr_accessor :reference_images + + # The rpc status for each ImportProductSet request, including both successes + # and errors. + # The number of statuses here matches the number of lines in the csv file, + # and statuses[i] stores the success or failure status of processing the i-th + # line of the csv, starting from line 0. + # Corresponds to the JSON property `statuses` + # @return [Array] + attr_accessor :statuses + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @reference_images = args[:reference_images] if args.key?(:reference_images) + @statuses = args[:statuses] if args.key?(:statuses) + end + end + # The desired input location and metadata. class InputConfig include Google::Apis::Core::Hashable @@ -6275,6 +6825,33 @@ module Google end end + # A product label represented as a key-value pair. + class KeyValue + include Google::Apis::Core::Hashable + + # The key of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # The value of the label attached to the product. Cannot be empty and + # cannot exceed 128 bytes. + # 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 + # A face-specific landmark (for example, a face feature). class Landmark include Google::Apis::Core::Hashable @@ -6702,6 +7279,97 @@ module Google end end + # A Product contains ReferenceImages. + class Product + include Google::Apis::Core::Hashable + + # User-provided metadata to be stored with this product. Must be at most 4096 + # characters long. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The user-provided name for this Product. Must not be empty. Must be at most + # 4096 characters long. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The resource name of the product. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + # This field is ignored when creating a product. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The category for the product identified by the reference image. This should + # be either "homegoods", "apparel", or "toys". + # This field is immutable. + # Corresponds to the JSON property `productCategory` + # @return [String] + attr_accessor :product_category + + # Key-value pairs that can be attached to a product. At query time, + # constraints can be specified based on the product_labels. + # Note that integer values can be provided as strings, e.g. "1199". Only + # strings with integer values can match a range-based restriction which is + # to be supported soon. + # Multiple values can be assigned to the same key. One product may have up to + # 100 product_labels. + # Corresponds to the JSON property `productLabels` + # @return [Array] + attr_accessor :product_labels + + 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) + @name = args[:name] if args.key?(:name) + @product_category = args[:product_category] if args.key?(:product_category) + @product_labels = args[:product_labels] if args.key?(:product_labels) + end + end + + # Results for a product search request. + class ProductSearchResults + include Google::Apis::Core::Hashable + + # Timestamp of the index which provided these results. Changes made after + # this time are not reflected in the current results. + # Corresponds to the JSON property `indexTime` + # @return [String] + attr_accessor :index_time + + # List of results grouped by products detected in the query image. Each entry + # corresponds to one bounding polygon in the query image, and contains the + # matching products specific to that region. There may be duplicate product + # matches in the union of all the per-product results. + # Corresponds to the JSON property `productGroupedResults` + # @return [Array] + attr_accessor :product_grouped_results + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @index_time = args[:index_time] if args.key?(:index_time) + @product_grouped_results = args[:product_grouped_results] if args.key?(:product_grouped_results) + @results = args[:results] if args.key?(:results) + end + end + # A `Property` consists of a user-supplied name/value pair. class Property include Google::Apis::Core::Hashable @@ -6733,6 +7401,83 @@ module Google end end + # A `ReferenceImage` represents a product image and its associated metadata, + # such as bounding boxes. + class ReferenceImage + include Google::Apis::Core::Hashable + + # Bounding polygons around the areas of interest in the reference image. + # Optional. If this field is empty, the system will try to detect regions of + # interest. At most 10 bounding polygons will be used. + # The provided shape is converted into a non-rotated rectangle. Once + # converted, the small edge of the rectangle must be greater than or equal + # to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 + # is not). + # Corresponds to the JSON property `boundingPolys` + # @return [Array] + attr_accessor :bounding_polys + + # The resource name of the reference image. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ + # IMAGE_ID`. + # This field is ignored when creating a reference image. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The Google Cloud Storage URI of the reference image. + # The URI must start with `gs://`. + # Required. + # 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) + @bounding_polys = args[:bounding_polys] if args.key?(:bounding_polys) + @name = args[:name] if args.key?(:name) + @uri = args[:uri] if args.key?(:uri) + end + end + + # Information about a product. + class Result + include Google::Apis::Core::Hashable + + # The resource name of the image from the product that is the closest match + # to the query. + # Corresponds to the JSON property `image` + # @return [String] + attr_accessor :image + + # A Product contains ReferenceImages. + # Corresponds to the JSON property `product` + # @return [Google::Apis::VisionV1p1beta1::Product] + attr_accessor :product + + # A confidence level on the match, ranging from 0 (no confidence) to + # 1 (full confidence). + # 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) + @image = args[:image] if args.key?(:image) + @product = args[:product] if args.key?(:product) + @score = args[:score] if args.key?(:score) + end + end + # Set of features pertaining to the image, computed by computer vision # methods over safe-search verticals (for example, adult, spoof, medical, # violence). diff --git a/generated/google/apis/vision_v1p1beta1/representations.rb b/generated/google/apis/vision_v1p1beta1/representations.rb index a87a36946..9c7ff0cef 100644 --- a/generated/google/apis/vision_v1p1beta1/representations.rb +++ b/generated/google/apis/vision_v1p1beta1/representations.rb @@ -46,6 +46,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class BatchOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Block class Representation < Google::Apis::Core::JsonRepresentation; end @@ -340,6 +346,42 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVisionV1p1beta1Product + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ProductKeyValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ProductSearchParams + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ProductSearchResults + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ProductSearchResultsResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVisionV1p1beta1Property class Representation < Google::Apis::Core::JsonRepresentation; end @@ -586,6 +628,36 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVisionV1p2beta1Product + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p2beta1ProductKeyValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p2beta1ProductSearchResults + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p2beta1ProductSearchResultsResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVisionV1p2beta1Property class Representation < Google::Apis::Core::JsonRepresentation; end @@ -856,6 +928,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVisionV1p3beta1ProductSearchResultsResult class Representation < Google::Apis::Core::JsonRepresentation; end @@ -952,6 +1030,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GroupedResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ImageAnnotationContext class Representation < Google::Apis::Core::JsonRepresentation; end @@ -964,12 +1048,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ImportProductSetsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class InputConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class KeyValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Landmark class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1036,12 +1132,36 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Product + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ProductSearchResults + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Property class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class ReferenceImage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Result + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SafeSearchAnnotation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1147,6 +1267,8 @@ module Google collection :logo_annotations, as: 'logoAnnotations', class: Google::Apis::VisionV1p1beta1::EntityAnnotation, decorator: Google::Apis::VisionV1p1beta1::EntityAnnotation::Representation + property :product_search_results, as: 'productSearchResults', class: Google::Apis::VisionV1p1beta1::ProductSearchResults, decorator: Google::Apis::VisionV1p1beta1::ProductSearchResults::Representation + property :safe_search_annotation, as: 'safeSearchAnnotation', class: Google::Apis::VisionV1p1beta1::SafeSearchAnnotation, decorator: Google::Apis::VisionV1p1beta1::SafeSearchAnnotation::Representation collection :text_annotations, as: 'textAnnotations', class: Google::Apis::VisionV1p1beta1::EntityAnnotation, decorator: Google::Apis::VisionV1p1beta1::EntityAnnotation::Representation @@ -1172,6 +1294,15 @@ module Google end end + class BatchOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + property :state, as: 'state' + property :submit_time, as: 'submitTime' + end + end + class Block # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1359,6 +1490,8 @@ module Google collection :logo_annotations, as: 'logoAnnotations', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1EntityAnnotation, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1EntityAnnotation::Representation + property :product_search_results, as: 'productSearchResults', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductSearchResults, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductSearchResults::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 @@ -1586,6 +1719,8 @@ module Google collection :language_hints, as: 'languageHints' property :lat_long_rect, as: 'latLongRect', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1LatLongRect, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1LatLongRect::Representation + property :product_search_params, as: 'productSearchParams', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductSearchParams, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductSearchParams::Representation + property :web_detection_params, as: 'webDetectionParams', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionParams, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1WebDetectionParams::Representation end @@ -1699,6 +1834,68 @@ module Google end end + class GoogleCloudVisionV1p1beta1Product + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + property :name, as: 'name' + property :product_category, as: 'productCategory' + collection :product_labels, as: 'productLabels', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductKeyValue, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductKeyValue::Representation + + end + end + + class GoogleCloudVisionV1p1beta1ProductKeyValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + + class GoogleCloudVisionV1p1beta1ProductSearchParams + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly::Representation + + property :filter, as: 'filter' + collection :product_categories, as: 'productCategories' + property :product_set, as: 'productSet' + end + end + + class GoogleCloudVisionV1p1beta1ProductSearchResults + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :index_time, as: 'indexTime' + collection :product_grouped_results, as: 'productGroupedResults', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p1beta1ProductSearchResultsResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image, as: 'image' + property :product, as: 'product', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Product, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Product::Representation + + property :score, as: 'score' + end + end + class GoogleCloudVisionV1p1beta1Property # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1883,6 +2080,8 @@ module Google collection :logo_annotations, as: 'logoAnnotations', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1EntityAnnotation, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1EntityAnnotation::Representation + property :product_search_results, as: 'productSearchResults', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ProductSearchResults, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ProductSearchResults::Representation + property :safe_search_annotation, as: 'safeSearchAnnotation', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1SafeSearchAnnotation, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1SafeSearchAnnotation::Representation collection :text_annotations, as: 'textAnnotations', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1EntityAnnotation, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1EntityAnnotation::Representation @@ -2139,6 +2338,57 @@ module Google end end + class GoogleCloudVisionV1p2beta1Product + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + property :name, as: 'name' + property :product_category, as: 'productCategory' + collection :product_labels, as: 'productLabels', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ProductKeyValue, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ProductKeyValue::Representation + + end + end + + class GoogleCloudVisionV1p2beta1ProductKeyValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + + class GoogleCloudVisionV1p2beta1ProductSearchResults + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :index_time, as: 'indexTime' + collection :product_grouped_results, as: 'productGroupedResults', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1BoundingPoly, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1BoundingPoly::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p2beta1ProductSearchResultsResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image, as: 'image' + property :product, as: 'product', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1Product, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1Product::Representation + + property :score, as: 'score' + end + end + class GoogleCloudVisionV1p2beta1Property # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2617,6 +2867,18 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :index_time, as: 'indexTime' + collection :product_grouped_results, as: 'productGroupedResults', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1BoundingPoly, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1BoundingPoly::Representation + collection :results, as: 'results', class: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1ProductSearchResultsResult::Representation end @@ -2786,6 +3048,16 @@ module Google end end + class GroupedResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1p1beta1::BoundingPoly, decorator: Google::Apis::VisionV1p1beta1::BoundingPoly::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1p1beta1::Result, decorator: Google::Apis::VisionV1p1beta1::Result::Representation + + end + end + class ImageAnnotationContext # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2802,6 +3074,16 @@ module Google end end + class ImportProductSetsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :reference_images, as: 'referenceImages', class: Google::Apis::VisionV1p1beta1::ReferenceImage, decorator: Google::Apis::VisionV1p1beta1::ReferenceImage::Representation + + collection :statuses, as: 'statuses', class: Google::Apis::VisionV1p1beta1::Status, decorator: Google::Apis::VisionV1p1beta1::Status::Representation + + end + end + class InputConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2811,6 +3093,14 @@ module Google end end + class KeyValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + class Landmark # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2921,6 +3211,29 @@ module Google end end + class Product + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + property :name, as: 'name' + property :product_category, as: 'productCategory' + collection :product_labels, as: 'productLabels', class: Google::Apis::VisionV1p1beta1::KeyValue, decorator: Google::Apis::VisionV1p1beta1::KeyValue::Representation + + end + end + + class ProductSearchResults + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :index_time, as: 'indexTime' + collection :product_grouped_results, as: 'productGroupedResults', class: Google::Apis::VisionV1p1beta1::GroupedResult, decorator: Google::Apis::VisionV1p1beta1::GroupedResult::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1p1beta1::Result, decorator: Google::Apis::VisionV1p1beta1::Result::Representation + + end + end + class Property # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2930,6 +3243,26 @@ module Google end end + class ReferenceImage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :bounding_polys, as: 'boundingPolys', class: Google::Apis::VisionV1p1beta1::BoundingPoly, decorator: Google::Apis::VisionV1p1beta1::BoundingPoly::Representation + + property :name, as: 'name' + property :uri, as: 'uri' + end + end + + class Result + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image, as: 'image' + property :product, as: 'product', class: Google::Apis::VisionV1p1beta1::Product, decorator: Google::Apis::VisionV1p1beta1::Product::Representation + + property :score, as: 'score' + end + end + class SafeSearchAnnotation # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/vision_v1p2beta1.rb b/generated/google/apis/vision_v1p2beta1.rb index 753132346..5f0937ff4 100644 --- a/generated/google/apis/vision_v1p2beta1.rb +++ b/generated/google/apis/vision_v1p2beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/vision/ module VisionV1p2beta1 VERSION = 'V1p2beta1' - REVISION = '20180928' + REVISION = '20181031' # 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_v1p2beta1/classes.rb b/generated/google/apis/vision_v1p2beta1/classes.rb index 9bcdfa233..9bd1b560c 100644 --- a/generated/google/apis/vision_v1p2beta1/classes.rb +++ b/generated/google/apis/vision_v1p2beta1/classes.rb @@ -148,6 +148,11 @@ module Google # @return [Array] attr_accessor :logo_annotations + # Results for a product search request. + # Corresponds to the JSON property `productSearchResults` + # @return [Google::Apis::VisionV1p2beta1::ProductSearchResults] + attr_accessor :product_search_results + # Set of features pertaining to the image, computed by computer vision # methods over safe-search verticals (for example, adult, spoof, medical, # violence). @@ -181,6 +186,7 @@ module Google @landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations) @localized_object_annotations = args[:localized_object_annotations] if args.key?(:localized_object_annotations) @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations) + @product_search_results = args[:product_search_results] if args.key?(:product_search_results) @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) @@ -226,6 +232,40 @@ module Google end end + # Metadata for the batch operations such as the current state. + # This is included in the `metadata` field of the `Operation` returned by the + # `GetOperation` call of the `google::longrunning::Operations` service. + class BatchOperationMetadata + include Google::Apis::Core::Hashable + + # The time when the batch request is finished and + # google.longrunning.Operation.done is set to true. + # Corresponds to the JSON property `endTime` + # @return [String] + attr_accessor :end_time + + # The current state of the batch operation. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # The time when the batch request was submitted to the server. + # Corresponds to the JSON property `submitTime` + # @return [String] + attr_accessor :submit_time + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_time = args[:end_time] if args.key?(:end_time) + @state = args[:state] if args.key?(:state) + @submit_time = args[:submit_time] if args.key?(:submit_time) + end + end + # Logical element on the page. class Block include Google::Apis::Core::Hashable @@ -1058,6 +1098,11 @@ module Google # @return [Array] attr_accessor :logo_annotations + # Results for a product search request. + # Corresponds to the JSON property `productSearchResults` + # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1ProductSearchResults] + attr_accessor :product_search_results + # Set of features pertaining to the image, computed by computer vision # methods over safe-search verticals (for example, adult, spoof, medical, # violence). @@ -1091,6 +1136,7 @@ module Google @landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations) @localized_object_annotations = args[:localized_object_annotations] if args.key?(:localized_object_annotations) @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations) + @product_search_results = args[:product_search_results] if args.key?(:product_search_results) @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) @@ -1986,6 +2032,183 @@ module Google end end + # A Product contains ReferenceImages. + class GoogleCloudVisionV1p1beta1Product + include Google::Apis::Core::Hashable + + # User-provided metadata to be stored with this product. Must be at most 4096 + # characters long. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The user-provided name for this Product. Must not be empty. Must be at most + # 4096 characters long. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The resource name of the product. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + # This field is ignored when creating a product. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The category for the product identified by the reference image. This should + # be either "homegoods", "apparel", or "toys". + # This field is immutable. + # Corresponds to the JSON property `productCategory` + # @return [String] + attr_accessor :product_category + + # Key-value pairs that can be attached to a product. At query time, + # constraints can be specified based on the product_labels. + # Note that integer values can be provided as strings, e.g. "1199". Only + # strings with integer values can match a range-based restriction which is + # to be supported soon. + # Multiple values can be assigned to the same key. One product may have up to + # 100 product_labels. + # Corresponds to the JSON property `productLabels` + # @return [Array] + attr_accessor :product_labels + + 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) + @name = args[:name] if args.key?(:name) + @product_category = args[:product_category] if args.key?(:product_category) + @product_labels = args[:product_labels] if args.key?(:product_labels) + end + end + + # A product label represented as a key-value pair. + class GoogleCloudVisionV1p1beta1ProductKeyValue + include Google::Apis::Core::Hashable + + # The key of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # The value of the label attached to the product. Cannot be empty and + # cannot exceed 128 bytes. + # 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 + + # Results for a product search request. + class GoogleCloudVisionV1p1beta1ProductSearchResults + include Google::Apis::Core::Hashable + + # Timestamp of the index which provided these results. Changes made after + # this time are not reflected in the current results. + # Corresponds to the JSON property `indexTime` + # @return [String] + attr_accessor :index_time + + # List of results grouped by products detected in the query image. Each entry + # corresponds to one bounding polygon in the query image, and contains the + # matching products specific to that region. There may be duplicate product + # matches in the union of all the per-product results. + # Corresponds to the JSON property `productGroupedResults` + # @return [Array] + attr_accessor :product_grouped_results + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @index_time = args[:index_time] if args.key?(:index_time) + @product_grouped_results = args[:product_grouped_results] if args.key?(:product_grouped_results) + @results = args[:results] if args.key?(:results) + end + end + + # Information about the products similar to a single product in a query + # image. + class GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1BoundingPoly] + attr_accessor :bounding_poly + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @results = args[:results] if args.key?(:results) + end + end + + # Information about a product. + class GoogleCloudVisionV1p1beta1ProductSearchResultsResult + include Google::Apis::Core::Hashable + + # The resource name of the image from the product that is the closest match + # to the query. + # Corresponds to the JSON property `image` + # @return [String] + attr_accessor :image + + # A Product contains ReferenceImages. + # Corresponds to the JSON property `product` + # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1Product] + attr_accessor :product + + # A confidence level on the match, ranging from 0 (no confidence) to + # 1 (full confidence). + # 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) + @image = args[:image] if args.key?(:image) + @product = args[:product] if args.key?(:product) + @score = args[:score] if args.key?(:score) + end + end + # A `Property` consists of a user-supplied name/value pair. class GoogleCloudVisionV1p1beta1Property include Google::Apis::Core::Hashable @@ -2621,6 +2844,11 @@ module Google # @return [Array] attr_accessor :logo_annotations + # Results for a product search request. + # Corresponds to the JSON property `productSearchResults` + # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchResults] + attr_accessor :product_search_results + # Set of features pertaining to the image, computed by computer vision # methods over safe-search verticals (for example, adult, spoof, medical, # violence). @@ -2654,6 +2882,7 @@ module Google @landmark_annotations = args[:landmark_annotations] if args.key?(:landmark_annotations) @localized_object_annotations = args[:localized_object_annotations] if args.key?(:localized_object_annotations) @logo_annotations = args[:logo_annotations] if args.key?(:logo_annotations) + @product_search_results = args[:product_search_results] if args.key?(:product_search_results) @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) @@ -3472,6 +3701,11 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1LatLongRect] attr_accessor :lat_long_rect + # Parameters for a product search request. + # Corresponds to the JSON property `productSearchParams` + # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchParams] + attr_accessor :product_search_params + # Parameters for web detection request. # Corresponds to the JSON property `webDetectionParams` # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1WebDetectionParams] @@ -3486,6 +3720,7 @@ module Google @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) + @product_search_params = args[:product_search_params] if args.key?(:product_search_params) @web_detection_params = args[:web_detection_params] if args.key?(:web_detection_params) end end @@ -3884,6 +4119,228 @@ module Google end end + # A Product contains ReferenceImages. + class GoogleCloudVisionV1p2beta1Product + include Google::Apis::Core::Hashable + + # User-provided metadata to be stored with this product. Must be at most 4096 + # characters long. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The user-provided name for this Product. Must not be empty. Must be at most + # 4096 characters long. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The resource name of the product. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + # This field is ignored when creating a product. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The category for the product identified by the reference image. This should + # be either "homegoods", "apparel", or "toys". + # This field is immutable. + # Corresponds to the JSON property `productCategory` + # @return [String] + attr_accessor :product_category + + # Key-value pairs that can be attached to a product. At query time, + # constraints can be specified based on the product_labels. + # Note that integer values can be provided as strings, e.g. "1199". Only + # strings with integer values can match a range-based restriction which is + # to be supported soon. + # Multiple values can be assigned to the same key. One product may have up to + # 100 product_labels. + # Corresponds to the JSON property `productLabels` + # @return [Array] + attr_accessor :product_labels + + 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) + @name = args[:name] if args.key?(:name) + @product_category = args[:product_category] if args.key?(:product_category) + @product_labels = args[:product_labels] if args.key?(:product_labels) + end + end + + # A product label represented as a key-value pair. + class GoogleCloudVisionV1p2beta1ProductKeyValue + include Google::Apis::Core::Hashable + + # The key of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # The value of the label attached to the product. Cannot be empty and + # cannot exceed 128 bytes. + # 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 + + # Parameters for a product search request. + class GoogleCloudVisionV1p2beta1ProductSearchParams + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BoundingPoly] + attr_accessor :bounding_poly + + # The filtering expression. This can be used to restrict search results based + # on Product labels. We currently support an AND of OR of key-value + # expressions, where each expression within an OR must have the same key. + # For example, "(color = red OR color = blue) AND brand = Google" is + # acceptable, but not "(color = red OR brand = Google)" or "color: red". + # Corresponds to the JSON property `filter` + # @return [String] + attr_accessor :filter + + # The list of product categories to search in. Currently, we only consider + # the first category, and either "homegoods", "apparel", or "toys" should be + # specified. + # Corresponds to the JSON property `productCategories` + # @return [Array] + attr_accessor :product_categories + + # The resource name of a ProductSet to be searched for similar images. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. + # Corresponds to the JSON property `productSet` + # @return [String] + attr_accessor :product_set + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @filter = args[:filter] if args.key?(:filter) + @product_categories = args[:product_categories] if args.key?(:product_categories) + @product_set = args[:product_set] if args.key?(:product_set) + end + end + + # Results for a product search request. + class GoogleCloudVisionV1p2beta1ProductSearchResults + include Google::Apis::Core::Hashable + + # Timestamp of the index which provided these results. Changes made after + # this time are not reflected in the current results. + # Corresponds to the JSON property `indexTime` + # @return [String] + attr_accessor :index_time + + # List of results grouped by products detected in the query image. Each entry + # corresponds to one bounding polygon in the query image, and contains the + # matching products specific to that region. There may be duplicate product + # matches in the union of all the per-product results. + # Corresponds to the JSON property `productGroupedResults` + # @return [Array] + attr_accessor :product_grouped_results + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @index_time = args[:index_time] if args.key?(:index_time) + @product_grouped_results = args[:product_grouped_results] if args.key?(:product_grouped_results) + @results = args[:results] if args.key?(:results) + end + end + + # Information about the products similar to a single product in a query + # image. + class GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BoundingPoly] + attr_accessor :bounding_poly + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @results = args[:results] if args.key?(:results) + end + end + + # Information about a product. + class GoogleCloudVisionV1p2beta1ProductSearchResultsResult + include Google::Apis::Core::Hashable + + # The resource name of the image from the product that is the closest match + # to the query. + # Corresponds to the JSON property `image` + # @return [String] + attr_accessor :image + + # A Product contains ReferenceImages. + # Corresponds to the JSON property `product` + # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1Product] + attr_accessor :product + + # A confidence level on the match, ranging from 0 (no confidence) to + # 1 (full confidence). + # 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) + @image = args[:image] if args.key?(:image) + @product = args[:product] if args.key?(:product) + @score = args[:score] if args.key?(:score) + end + end + # A `Property` consists of a user-supplied name/value pair. class GoogleCloudVisionV1p2beta1Property include Google::Apis::Core::Hashable @@ -5633,6 +6090,14 @@ module Google # @return [String] attr_accessor :index_time + # List of results grouped by products detected in the query image. Each entry + # corresponds to one bounding polygon in the query image, and contains the + # matching products specific to that region. There may be duplicate product + # matches in the union of all the per-product results. + # Corresponds to the JSON property `productGroupedResults` + # @return [Array] + attr_accessor :product_grouped_results + # List of results, one for each product match. # Corresponds to the JSON property `results` # @return [Array] @@ -5645,6 +6110,33 @@ module Google # Update properties of this object def update!(**args) @index_time = args[:index_time] if args.key?(:index_time) + @product_grouped_results = args[:product_grouped_results] if args.key?(:product_grouped_results) + @results = args[:results] if args.key?(:results) + end + end + + # Information about the products similar to a single product in a query + # image. + class GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1BoundingPoly] + attr_accessor :bounding_poly + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) @results = args[:results] if args.key?(:results) end end @@ -6203,6 +6695,32 @@ module Google end end + # Information about the products similar to a single product in a query + # image. + class GroupedResult + include Google::Apis::Core::Hashable + + # A bounding polygon for the detected image annotation. + # Corresponds to the JSON property `boundingPoly` + # @return [Google::Apis::VisionV1p2beta1::BoundingPoly] + attr_accessor :bounding_poly + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bounding_poly = args[:bounding_poly] if args.key?(:bounding_poly) + @results = args[:results] if args.key?(:results) + end + end + # If an image was produced from a file (e.g. a PDF), this message gives # information about the source of that image. class ImageAnnotationContext @@ -6249,6 +6767,38 @@ module Google end end + # Response message for the `ImportProductSets` method. + # This message is returned by the + # google.longrunning.Operations.GetOperation method in the returned + # google.longrunning.Operation.response field. + class ImportProductSetsResponse + include Google::Apis::Core::Hashable + + # The list of reference_images that are imported successfully. + # Corresponds to the JSON property `referenceImages` + # @return [Array] + attr_accessor :reference_images + + # The rpc status for each ImportProductSet request, including both successes + # and errors. + # The number of statuses here matches the number of lines in the csv file, + # and statuses[i] stores the success or failure status of processing the i-th + # line of the csv, starting from line 0. + # Corresponds to the JSON property `statuses` + # @return [Array] + attr_accessor :statuses + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @reference_images = args[:reference_images] if args.key?(:reference_images) + @statuses = args[:statuses] if args.key?(:statuses) + end + end + # The desired input location and metadata. class InputConfig include Google::Apis::Core::Hashable @@ -6275,6 +6825,33 @@ module Google end end + # A product label represented as a key-value pair. + class KeyValue + include Google::Apis::Core::Hashable + + # The key of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. + # Corresponds to the JSON property `key` + # @return [String] + attr_accessor :key + + # The value of the label attached to the product. Cannot be empty and + # cannot exceed 128 bytes. + # 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 + # A face-specific landmark (for example, a face feature). class Landmark include Google::Apis::Core::Hashable @@ -6702,6 +7279,97 @@ module Google end end + # A Product contains ReferenceImages. + class Product + include Google::Apis::Core::Hashable + + # User-provided metadata to be stored with this product. Must be at most 4096 + # characters long. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The user-provided name for this Product. Must not be empty. Must be at most + # 4096 characters long. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # The resource name of the product. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + # This field is ignored when creating a product. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The category for the product identified by the reference image. This should + # be either "homegoods", "apparel", or "toys". + # This field is immutable. + # Corresponds to the JSON property `productCategory` + # @return [String] + attr_accessor :product_category + + # Key-value pairs that can be attached to a product. At query time, + # constraints can be specified based on the product_labels. + # Note that integer values can be provided as strings, e.g. "1199". Only + # strings with integer values can match a range-based restriction which is + # to be supported soon. + # Multiple values can be assigned to the same key. One product may have up to + # 100 product_labels. + # Corresponds to the JSON property `productLabels` + # @return [Array] + attr_accessor :product_labels + + 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) + @name = args[:name] if args.key?(:name) + @product_category = args[:product_category] if args.key?(:product_category) + @product_labels = args[:product_labels] if args.key?(:product_labels) + end + end + + # Results for a product search request. + class ProductSearchResults + include Google::Apis::Core::Hashable + + # Timestamp of the index which provided these results. Changes made after + # this time are not reflected in the current results. + # Corresponds to the JSON property `indexTime` + # @return [String] + attr_accessor :index_time + + # List of results grouped by products detected in the query image. Each entry + # corresponds to one bounding polygon in the query image, and contains the + # matching products specific to that region. There may be duplicate product + # matches in the union of all the per-product results. + # Corresponds to the JSON property `productGroupedResults` + # @return [Array] + attr_accessor :product_grouped_results + + # List of results, one for each product match. + # Corresponds to the JSON property `results` + # @return [Array] + attr_accessor :results + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @index_time = args[:index_time] if args.key?(:index_time) + @product_grouped_results = args[:product_grouped_results] if args.key?(:product_grouped_results) + @results = args[:results] if args.key?(:results) + end + end + # A `Property` consists of a user-supplied name/value pair. class Property include Google::Apis::Core::Hashable @@ -6733,6 +7401,83 @@ module Google end end + # A `ReferenceImage` represents a product image and its associated metadata, + # such as bounding boxes. + class ReferenceImage + include Google::Apis::Core::Hashable + + # Bounding polygons around the areas of interest in the reference image. + # Optional. If this field is empty, the system will try to detect regions of + # interest. At most 10 bounding polygons will be used. + # The provided shape is converted into a non-rotated rectangle. Once + # converted, the small edge of the rectangle must be greater than or equal + # to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 + # is not). + # Corresponds to the JSON property `boundingPolys` + # @return [Array] + attr_accessor :bounding_polys + + # The resource name of the reference image. + # Format is: + # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ + # IMAGE_ID`. + # This field is ignored when creating a reference image. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The Google Cloud Storage URI of the reference image. + # The URI must start with `gs://`. + # Required. + # 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) + @bounding_polys = args[:bounding_polys] if args.key?(:bounding_polys) + @name = args[:name] if args.key?(:name) + @uri = args[:uri] if args.key?(:uri) + end + end + + # Information about a product. + class Result + include Google::Apis::Core::Hashable + + # The resource name of the image from the product that is the closest match + # to the query. + # Corresponds to the JSON property `image` + # @return [String] + attr_accessor :image + + # A Product contains ReferenceImages. + # Corresponds to the JSON property `product` + # @return [Google::Apis::VisionV1p2beta1::Product] + attr_accessor :product + + # A confidence level on the match, ranging from 0 (no confidence) to + # 1 (full confidence). + # 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) + @image = args[:image] if args.key?(:image) + @product = args[:product] if args.key?(:product) + @score = args[:score] if args.key?(:score) + end + end + # Set of features pertaining to the image, computed by computer vision # methods over safe-search verticals (for example, adult, spoof, medical, # violence). diff --git a/generated/google/apis/vision_v1p2beta1/representations.rb b/generated/google/apis/vision_v1p2beta1/representations.rb index eb4f7e06e..317b3191b 100644 --- a/generated/google/apis/vision_v1p2beta1/representations.rb +++ b/generated/google/apis/vision_v1p2beta1/representations.rb @@ -46,6 +46,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class BatchOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Block class Representation < Google::Apis::Core::JsonRepresentation; end @@ -274,6 +280,36 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVisionV1p1beta1Product + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ProductKeyValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ProductSearchResults + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p1beta1ProductSearchResultsResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVisionV1p1beta1Property class Representation < Google::Apis::Core::JsonRepresentation; end @@ -580,6 +616,42 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVisionV1p2beta1Product + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p2beta1ProductKeyValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p2beta1ProductSearchParams + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p2beta1ProductSearchResults + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudVisionV1p2beta1ProductSearchResultsResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVisionV1p2beta1Property class Representation < Google::Apis::Core::JsonRepresentation; end @@ -856,6 +928,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudVisionV1p3beta1ProductSearchResultsResult class Representation < Google::Apis::Core::JsonRepresentation; end @@ -952,6 +1030,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GroupedResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ImageAnnotationContext class Representation < Google::Apis::Core::JsonRepresentation; end @@ -964,12 +1048,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ImportProductSetsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class InputConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class KeyValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Landmark class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1036,12 +1132,36 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Product + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ProductSearchResults + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Property class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class ReferenceImage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Result + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class SafeSearchAnnotation class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1147,6 +1267,8 @@ module Google collection :logo_annotations, as: 'logoAnnotations', class: Google::Apis::VisionV1p2beta1::EntityAnnotation, decorator: Google::Apis::VisionV1p2beta1::EntityAnnotation::Representation + property :product_search_results, as: 'productSearchResults', class: Google::Apis::VisionV1p2beta1::ProductSearchResults, decorator: Google::Apis::VisionV1p2beta1::ProductSearchResults::Representation + property :safe_search_annotation, as: 'safeSearchAnnotation', class: Google::Apis::VisionV1p2beta1::SafeSearchAnnotation, decorator: Google::Apis::VisionV1p2beta1::SafeSearchAnnotation::Representation collection :text_annotations, as: 'textAnnotations', class: Google::Apis::VisionV1p2beta1::EntityAnnotation, decorator: Google::Apis::VisionV1p2beta1::EntityAnnotation::Representation @@ -1172,6 +1294,15 @@ module Google end end + class BatchOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_time, as: 'endTime' + property :state, as: 'state' + property :submit_time, as: 'submitTime' + end + end + class Block # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1347,6 +1478,8 @@ module Google collection :logo_annotations, as: 'logoAnnotations', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1EntityAnnotation, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1EntityAnnotation::Representation + property :product_search_results, as: 'productSearchResults', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1ProductSearchResults, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1ProductSearchResults::Representation + property :safe_search_annotation, as: 'safeSearchAnnotation', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1SafeSearchAnnotation, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1SafeSearchAnnotation::Representation collection :text_annotations, as: 'textAnnotations', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1EntityAnnotation, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1EntityAnnotation::Representation @@ -1593,6 +1726,57 @@ module Google end end + class GoogleCloudVisionV1p1beta1Product + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + property :name, as: 'name' + property :product_category, as: 'productCategory' + collection :product_labels, as: 'productLabels', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1ProductKeyValue, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1ProductKeyValue::Representation + + end + end + + class GoogleCloudVisionV1p1beta1ProductKeyValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + + class GoogleCloudVisionV1p1beta1ProductSearchResults + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :index_time, as: 'indexTime' + collection :product_grouped_results, as: 'productGroupedResults', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1BoundingPoly, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1BoundingPoly::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p1beta1ProductSearchResultsResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image, as: 'image' + property :product, as: 'product', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1Product, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1Product::Representation + + property :score, as: 'score' + end + end + class GoogleCloudVisionV1p1beta1Property # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1782,6 +1966,8 @@ module Google collection :logo_annotations, as: 'logoAnnotations', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1EntityAnnotation, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1EntityAnnotation::Representation + property :product_search_results, as: 'productSearchResults', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchResults, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchResults::Representation + property :safe_search_annotation, as: 'safeSearchAnnotation', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1SafeSearchAnnotation, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1SafeSearchAnnotation::Representation collection :text_annotations, as: 'textAnnotations', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1EntityAnnotation, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1EntityAnnotation::Representation @@ -2011,6 +2197,8 @@ module Google collection :language_hints, as: 'languageHints' property :lat_long_rect, as: 'latLongRect', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1LatLongRect, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1LatLongRect::Representation + property :product_search_params, as: 'productSearchParams', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchParams, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchParams::Representation + property :web_detection_params, as: 'webDetectionParams', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1WebDetectionParams, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1WebDetectionParams::Representation end @@ -2132,6 +2320,68 @@ module Google end end + class GoogleCloudVisionV1p2beta1Product + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + property :name, as: 'name' + property :product_category, as: 'productCategory' + collection :product_labels, as: 'productLabels', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductKeyValue, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductKeyValue::Representation + + end + end + + class GoogleCloudVisionV1p2beta1ProductKeyValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + + class GoogleCloudVisionV1p2beta1ProductSearchParams + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BoundingPoly, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BoundingPoly::Representation + + property :filter, as: 'filter' + collection :product_categories, as: 'productCategories' + property :product_set, as: 'productSet' + end + end + + class GoogleCloudVisionV1p2beta1ProductSearchResults + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :index_time, as: 'indexTime' + collection :product_grouped_results, as: 'productGroupedResults', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BoundingPoly, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BoundingPoly::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p2beta1ProductSearchResultsResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image, as: 'image' + property :product, as: 'product', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1Product, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1Product::Representation + + property :score, as: 'score' + end + end + class GoogleCloudVisionV1p2beta1Property # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2617,6 +2867,18 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :index_time, as: 'indexTime' + collection :product_grouped_results, as: 'productGroupedResults', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1ProductSearchResultsResult::Representation + + end + end + + class GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1BoundingPoly, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1BoundingPoly::Representation + collection :results, as: 'results', class: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1ProductSearchResultsResult, decorator: Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1ProductSearchResultsResult::Representation end @@ -2786,6 +3048,16 @@ module Google end end + class GroupedResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bounding_poly, as: 'boundingPoly', class: Google::Apis::VisionV1p2beta1::BoundingPoly, decorator: Google::Apis::VisionV1p2beta1::BoundingPoly::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1p2beta1::Result, decorator: Google::Apis::VisionV1p2beta1::Result::Representation + + end + end + class ImageAnnotationContext # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2802,6 +3074,16 @@ module Google end end + class ImportProductSetsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :reference_images, as: 'referenceImages', class: Google::Apis::VisionV1p2beta1::ReferenceImage, decorator: Google::Apis::VisionV1p2beta1::ReferenceImage::Representation + + collection :statuses, as: 'statuses', class: Google::Apis::VisionV1p2beta1::Status, decorator: Google::Apis::VisionV1p2beta1::Status::Representation + + end + end + class InputConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2811,6 +3093,14 @@ module Google end end + class KeyValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + property :value, as: 'value' + end + end + class Landmark # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2921,6 +3211,29 @@ module Google end end + class Product + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :display_name, as: 'displayName' + property :name, as: 'name' + property :product_category, as: 'productCategory' + collection :product_labels, as: 'productLabels', class: Google::Apis::VisionV1p2beta1::KeyValue, decorator: Google::Apis::VisionV1p2beta1::KeyValue::Representation + + end + end + + class ProductSearchResults + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :index_time, as: 'indexTime' + collection :product_grouped_results, as: 'productGroupedResults', class: Google::Apis::VisionV1p2beta1::GroupedResult, decorator: Google::Apis::VisionV1p2beta1::GroupedResult::Representation + + collection :results, as: 'results', class: Google::Apis::VisionV1p2beta1::Result, decorator: Google::Apis::VisionV1p2beta1::Result::Representation + + end + end + class Property # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2930,6 +3243,26 @@ module Google end end + class ReferenceImage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :bounding_polys, as: 'boundingPolys', class: Google::Apis::VisionV1p2beta1::BoundingPoly, decorator: Google::Apis::VisionV1p2beta1::BoundingPoly::Representation + + property :name, as: 'name' + property :uri, as: 'uri' + end + end + + class Result + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image, as: 'image' + property :product, as: 'product', class: Google::Apis::VisionV1p2beta1::Product, decorator: Google::Apis::VisionV1p2beta1::Product::Representation + + property :score, as: 'score' + end + end + class SafeSearchAnnotation # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/websecurityscanner_v1alpha.rb b/generated/google/apis/websecurityscanner_v1alpha.rb index 54cf81a84..36f896079 100644 --- a/generated/google/apis/websecurityscanner_v1alpha.rb +++ b/generated/google/apis/websecurityscanner_v1alpha.rb @@ -20,12 +20,12 @@ module Google module Apis # Web Security Scanner API # - # Web Security Scanner API (under development). + # Scans your Compute and App Engine apps for common web vulnerabilities. # # @see https://cloud.google.com/security-scanner/ module WebsecurityscannerV1alpha VERSION = 'V1alpha' - REVISION = '20180905' + REVISION = '20181024' # 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/websecurityscanner_v1alpha/service.rb b/generated/google/apis/websecurityscanner_v1alpha/service.rb index 8d85ffa6f..e8239f4f7 100644 --- a/generated/google/apis/websecurityscanner_v1alpha/service.rb +++ b/generated/google/apis/websecurityscanner_v1alpha/service.rb @@ -22,7 +22,7 @@ module Google module WebsecurityscannerV1alpha # Web Security Scanner API # - # Web Security Scanner API (under development). + # Scans your Compute and App Engine apps for common web vulnerabilities. # # @example # require 'google/apis/websecurityscanner_v1alpha' diff --git a/generated/google/apis/youtube_partner_v1.rb b/generated/google/apis/youtube_partner_v1.rb index 77d97236d..df7fb4cd1 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 = '20181008' + REVISION = '20181029' # 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_v3.rb b/generated/google/apis/youtube_v3.rb index 9552dec66..7eef6979f 100644 --- a/generated/google/apis/youtube_v3.rb +++ b/generated/google/apis/youtube_v3.rb @@ -31,7 +31,7 @@ module Google # Manage your YouTube account AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube' - # Manage your YouTube account + # See, edit, and permanently delete your YouTube videos, ratings, comments and captions AUTH_YOUTUBE_FORCE_SSL = 'https://www.googleapis.com/auth/youtube.force-ssl' # View your YouTube account